CrmApi.md

Apideck.Api.CrmApi

All URIs are relative to https://unify.apideck.com

Method	HTTP request	Description
ActivitiesAdd	POST /crm/activities	Create activity
ActivitiesAll	GET /crm/activities	List activities
ActivitiesDelete	DELETE /crm/activities/{id}	Delete activity
ActivitiesOne	GET /crm/activities/{id}	Get activity
ActivitiesUpdate	PATCH /crm/activities/{id}	Update activity
CompaniesAdd	POST /crm/companies	Create company
CompaniesAll	GET /crm/companies	List companies
CompaniesDelete	DELETE /crm/companies/{id}	Delete company
CompaniesOne	GET /crm/companies/{id}	Get company
CompaniesUpdate	PATCH /crm/companies/{id}	Update company
ContactsAdd	POST /crm/contacts	Create contact
ContactsAll	GET /crm/contacts	List contacts
ContactsDelete	DELETE /crm/contacts/{id}	Delete contact
ContactsOne	GET /crm/contacts/{id}	Get contact
ContactsUpdate	PATCH /crm/contacts/{id}	Update contact
LeadsAdd	POST /crm/leads	Create lead
LeadsAll	GET /crm/leads	List leads
LeadsDelete	DELETE /crm/leads/{id}	Delete lead
LeadsOne	GET /crm/leads/{id}	Get lead
LeadsUpdate	PATCH /crm/leads/{id}	Update lead
NotesAdd	POST /crm/notes	Create note
NotesAll	GET /crm/notes	List notes
NotesDelete	DELETE /crm/notes/{id}	Delete note
NotesOne	GET /crm/notes/{id}	Get note
NotesUpdate	PATCH /crm/notes/{id}	Update note
OpportunitiesAdd	POST /crm/opportunities	Create opportunity
OpportunitiesAll	GET /crm/opportunities	List opportunities
OpportunitiesDelete	DELETE /crm/opportunities/{id}	Delete opportunity
OpportunitiesOne	GET /crm/opportunities/{id}	Get opportunity
OpportunitiesUpdate	PATCH /crm/opportunities/{id}	Update opportunity
PipelinesAdd	POST /crm/pipelines	Create pipeline
PipelinesAll	GET /crm/pipelines	List pipelines
PipelinesDelete	DELETE /crm/pipelines/{id}	Delete pipeline
PipelinesOne	GET /crm/pipelines/{id}	Get pipeline
PipelinesUpdate	PATCH /crm/pipelines/{id}	Update pipeline
UsersAdd	POST /crm/users	Create user
UsersAll	GET /crm/users	List users
UsersDelete	DELETE /crm/users/{id}	Delete user
UsersOne	GET /crm/users/{id}	Get user
UsersUpdate	PATCH /crm/users/{id}	Update user

ActivitiesAdd

CreateActivityResponse ActivitiesAdd (Activity activity, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create activity

Create activity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ActivitiesAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var activity = new Activity(); // Activity | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create activity
                CreateActivityResponse result = apiInstance.ActivitiesAdd(activity, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ActivitiesAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
activity	Activity
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreateActivityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Activity created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ActivitiesAll

GetActivitiesResponse ActivitiesAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, ActivitiesFilter filter = null, ActivitiesSort sort = null, PassThroughQuery passThrough = null, string fields = null)

List activities

List activities

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ActivitiesAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var filter = new ActivitiesFilter(); // ActivitiesFilter | Apply filters (optional) 
            var sort = new ActivitiesSort(); // ActivitiesSort | Apply sorting (optional) 
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List activities
                GetActivitiesResponse result = apiInstance.ActivitiesAll(raw, consumerId, appId, serviceId, cursor, limit, filter, sort, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ActivitiesAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
filter	ActivitiesFilter	Apply filters	[optional]
sort	ActivitiesSort	Apply sorting	[optional]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetActivitiesResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Activities	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ActivitiesDelete

DeleteActivityResponse ActivitiesDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Delete activity

Delete activity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ActivitiesDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Delete activity
                DeleteActivityResponse result = apiInstance.ActivitiesDelete(id, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ActivitiesDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

DeleteActivityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Activity deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ActivitiesOne

GetActivityResponse ActivitiesOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)

Get activity

Get activity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ActivitiesOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // Get activity
                GetActivityResponse result = apiInstance.ActivitiesOne(id, consumerId, appId, serviceId, raw, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ActivitiesOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetActivityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Activity	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ActivitiesUpdate

UpdateActivityResponse ActivitiesUpdate (string id, Activity activity, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Update activity

Update activity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ActivitiesUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var activity = new Activity(); // Activity | 
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Update activity
                UpdateActivityResponse result = apiInstance.ActivitiesUpdate(id, activity, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ActivitiesUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
activity	Activity
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

UpdateActivityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Activity updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesAdd

CreateCompanyResponse CompaniesAdd (Company company, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create company

Create company

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class CompaniesAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var company = new Company(); // Company | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create company
                CreateCompanyResponse result = apiInstance.CompaniesAdd(company, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.CompaniesAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
company	Company
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreateCompanyResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Company created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesAll

GetCompaniesResponse CompaniesAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, CompaniesFilter filter = null, CompaniesSort sort = null, PassThroughQuery passThrough = null, string fields = null)

List companies

List companies

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class CompaniesAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var filter = new CompaniesFilter(); // CompaniesFilter | Apply filters (optional) 
            var sort = new CompaniesSort(); // CompaniesSort | Apply sorting (optional) 
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List companies
                GetCompaniesResponse result = apiInstance.CompaniesAll(raw, consumerId, appId, serviceId, cursor, limit, filter, sort, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.CompaniesAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
filter	CompaniesFilter	Apply filters	[optional]
sort	CompaniesSort	Apply sorting	[optional]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetCompaniesResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Companies	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesDelete

DeleteCompanyResponse CompaniesDelete (string id, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Delete company

Delete company

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class CompaniesDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Delete company
                DeleteCompanyResponse result = apiInstance.CompaniesDelete(id, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.CompaniesDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

DeleteCompanyResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Company deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesOne

GetCompanyResponse CompaniesOne (string id, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string fields = null)

Get company

Get company

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class CompaniesOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // Get company
                GetCompanyResponse result = apiInstance.CompaniesOne(id, raw, consumerId, appId, serviceId, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.CompaniesOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetCompanyResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Company	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesUpdate

UpdateCompanyResponse CompaniesUpdate (string id, Company company, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Update company

Update company

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class CompaniesUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var company = new Company(); // Company | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Update company
                UpdateCompanyResponse result = apiInstance.CompaniesUpdate(id, company, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.CompaniesUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
company	Company
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

UpdateCompanyResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Company updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContactsAdd

CreateContactResponse ContactsAdd (Contact contact, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create contact

Create contact

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ContactsAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var contact = new Contact(); // Contact | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create contact
                CreateContactResponse result = apiInstance.ContactsAdd(contact, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ContactsAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
contact	Contact
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreateContactResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Contact created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContactsAll

GetContactsResponse ContactsAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, ContactsFilter filter = null, ContactsSort sort = null, PassThroughQuery passThrough = null, string fields = null)

List contacts

List contacts

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ContactsAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var filter = new ContactsFilter(); // ContactsFilter | Apply filters (optional) 
            var sort = new ContactsSort(); // ContactsSort | Apply sorting (optional) 
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List contacts
                GetContactsResponse result = apiInstance.ContactsAll(raw, consumerId, appId, serviceId, cursor, limit, filter, sort, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ContactsAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
filter	ContactsFilter	Apply filters	[optional]
sort	ContactsSort	Apply sorting	[optional]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetContactsResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Contacts	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContactsDelete

DeleteContactResponse ContactsDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Delete contact

Delete contact

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ContactsDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Delete contact
                DeleteContactResponse result = apiInstance.ContactsDelete(id, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ContactsDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

DeleteContactResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Contact deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContactsOne

GetContactResponse ContactsOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null, ContactsFilter filter = null)

Get contact

Get contact

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ContactsOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 
            var filter = new ContactsFilter(); // ContactsFilter | Apply filters (optional) 

            try
            {
                // Get contact
                GetContactResponse result = apiInstance.ContactsOne(id, consumerId, appId, serviceId, raw, fields, filter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ContactsOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]
filter	ContactsFilter	Apply filters	[optional]

Return type

GetContactResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Contact	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContactsUpdate

UpdateContactResponse ContactsUpdate (string id, Contact contact, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Update contact

Update contact

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class ContactsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var contact = new Contact(); // Contact | 
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Update contact
                UpdateContactResponse result = apiInstance.ContactsUpdate(id, contact, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.ContactsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
contact	Contact
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

UpdateContactResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Contact updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LeadsAdd

CreateLeadResponse LeadsAdd (Lead lead, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create lead

Create lead

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class LeadsAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var lead = new Lead(); // Lead | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create lead
                CreateLeadResponse result = apiInstance.LeadsAdd(lead, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.LeadsAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
lead	Lead
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreateLeadResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Lead created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LeadsAll

GetLeadsResponse LeadsAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, LeadsFilter filter = null, LeadsSort sort = null, PassThroughQuery passThrough = null, string fields = null)

List leads

List leads

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class LeadsAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var filter = new LeadsFilter(); // LeadsFilter | Apply filters (optional) 
            var sort = new LeadsSort(); // LeadsSort | Apply sorting (optional) 
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List leads
                GetLeadsResponse result = apiInstance.LeadsAll(raw, consumerId, appId, serviceId, cursor, limit, filter, sort, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.LeadsAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
filter	LeadsFilter	Apply filters	[optional]
sort	LeadsSort	Apply sorting	[optional]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetLeadsResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Leads	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LeadsDelete

DeleteLeadResponse LeadsDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Delete lead

Delete lead

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class LeadsDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Delete lead
                DeleteLeadResponse result = apiInstance.LeadsDelete(id, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.LeadsDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

DeleteLeadResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Lead deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LeadsOne

GetLeadResponse LeadsOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)

Get lead

Get lead

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class LeadsOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // Get lead
                GetLeadResponse result = apiInstance.LeadsOne(id, consumerId, appId, serviceId, raw, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.LeadsOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetLeadResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Lead	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LeadsUpdate

UpdateLeadResponse LeadsUpdate (string id, Lead lead, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Update lead

Update lead

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class LeadsUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var lead = new Lead(); // Lead | 
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Update lead
                UpdateLeadResponse result = apiInstance.LeadsUpdate(id, lead, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.LeadsUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
lead	Lead
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

UpdateLeadResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Lead updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NotesAdd

CreateNoteResponse NotesAdd (Note note, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create note

Create note

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class NotesAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var note = new Note(); // Note | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create note
                CreateNoteResponse result = apiInstance.NotesAdd(note, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.NotesAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
note	Note
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreateNoteResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Note created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NotesAll

GetNotesResponse NotesAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, PassThroughQuery passThrough = null, string fields = null)

List notes

List notes

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class NotesAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List notes
                GetNotesResponse result = apiInstance.NotesAll(raw, consumerId, appId, serviceId, cursor, limit, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.NotesAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetNotesResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Notes	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NotesDelete

DeleteNoteResponse NotesDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Delete note

Delete note

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class NotesDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Delete note
                DeleteNoteResponse result = apiInstance.NotesDelete(id, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.NotesDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

DeleteNoteResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Note deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NotesOne

GetNoteResponse NotesOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)

Get note

Get note

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class NotesOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // Get note
                GetNoteResponse result = apiInstance.NotesOne(id, consumerId, appId, serviceId, raw, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.NotesOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetNoteResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Note	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NotesUpdate

UpdateNoteResponse NotesUpdate (string id, Note note, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Update note

Update note

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class NotesUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var note = new Note(); // Note | 
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Update note
                UpdateNoteResponse result = apiInstance.NotesUpdate(id, note, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.NotesUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
note	Note
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

UpdateNoteResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Note updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OpportunitiesAdd

CreateOpportunityResponse OpportunitiesAdd (Opportunity opportunity, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create opportunity

Create opportunity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class OpportunitiesAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var opportunity = new Opportunity(); // Opportunity | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create opportunity
                CreateOpportunityResponse result = apiInstance.OpportunitiesAdd(opportunity, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.OpportunitiesAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
opportunity	Opportunity
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreateOpportunityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Opportunity created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OpportunitiesAll

GetOpportunitiesResponse OpportunitiesAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, OpportunitiesFilter filter = null, OpportunitiesSort sort = null, PassThroughQuery passThrough = null, string fields = null)

List opportunities

List opportunities

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class OpportunitiesAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var filter = new OpportunitiesFilter(); // OpportunitiesFilter | Apply filters (optional) 
            var sort = new OpportunitiesSort(); // OpportunitiesSort | Apply sorting (optional) 
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List opportunities
                GetOpportunitiesResponse result = apiInstance.OpportunitiesAll(raw, consumerId, appId, serviceId, cursor, limit, filter, sort, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.OpportunitiesAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
filter	OpportunitiesFilter	Apply filters	[optional]
sort	OpportunitiesSort	Apply sorting	[optional]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetOpportunitiesResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Opportunities	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OpportunitiesDelete

DeleteOpportunityResponse OpportunitiesDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Delete opportunity

Delete opportunity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class OpportunitiesDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Delete opportunity
                DeleteOpportunityResponse result = apiInstance.OpportunitiesDelete(id, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.OpportunitiesDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

DeleteOpportunityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Opportunity deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OpportunitiesOne

GetOpportunityResponse OpportunitiesOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)

Get opportunity

Get opportunity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class OpportunitiesOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // Get opportunity
                GetOpportunityResponse result = apiInstance.OpportunitiesOne(id, consumerId, appId, serviceId, raw, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.OpportunitiesOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetOpportunityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Opportunity	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OpportunitiesUpdate

UpdateOpportunityResponse OpportunitiesUpdate (string id, Opportunity opportunity, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Update opportunity

Update opportunity

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class OpportunitiesUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var opportunity = new Opportunity(); // Opportunity | 
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Update opportunity
                UpdateOpportunityResponse result = apiInstance.OpportunitiesUpdate(id, opportunity, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.OpportunitiesUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
opportunity	Opportunity
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

UpdateOpportunityResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Opportunity updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PipelinesAdd

CreatePipelineResponse PipelinesAdd (Pipeline pipeline, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create pipeline

Create pipeline

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class PipelinesAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var pipeline = new Pipeline(); // Pipeline | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create pipeline
                CreatePipelineResponse result = apiInstance.PipelinesAdd(pipeline, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.PipelinesAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
pipeline	Pipeline
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreatePipelineResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Pipeline created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PipelinesAll

GetPipelinesResponse PipelinesAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, PassThroughQuery passThrough = null, string fields = null)

List pipelines

List pipelines

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class PipelinesAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List pipelines
                GetPipelinesResponse result = apiInstance.PipelinesAll(raw, consumerId, appId, serviceId, cursor, limit, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.PipelinesAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetPipelinesResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pipelines	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PipelinesDelete

DeletePipelineResponse PipelinesDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Delete pipeline

Delete pipeline

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class PipelinesDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Delete pipeline
                DeletePipelineResponse result = apiInstance.PipelinesDelete(id, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.PipelinesDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

DeletePipelineResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pipeline deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PipelinesOne

GetPipelineResponse PipelinesOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)

Get pipeline

Get pipeline

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class PipelinesOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // Get pipeline
                GetPipelineResponse result = apiInstance.PipelinesOne(id, consumerId, appId, serviceId, raw, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.PipelinesOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetPipelineResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pipeline	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PipelinesUpdate

UpdatePipelineResponse PipelinesUpdate (string id, Pipeline pipeline, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Update pipeline

Update pipeline

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class PipelinesUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var pipeline = new Pipeline(); // Pipeline | 
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Update pipeline
                UpdatePipelineResponse result = apiInstance.PipelinesUpdate(id, pipeline, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.PipelinesUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
pipeline	Pipeline
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

UpdatePipelineResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pipeline updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersAdd

CreateUserResponse UsersAdd (User user, bool? raw = null, string consumerId = null, string appId = null, string serviceId = null)

Create user

Create user

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class UsersAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var user = new User(); // User | 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 

            try
            {
                // Create user
                CreateUserResponse result = apiInstance.UsersAdd(user, raw, consumerId, appId, serviceId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.UsersAdd: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
user	User
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]

Return type

CreateUserResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	User created	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersAll

GetUsersResponse UsersAll (bool? raw = null, string consumerId = null, string appId = null, string serviceId = null, string cursor = null, int? limit = null, PassThroughQuery passThrough = null, string fields = null)

List users

List users

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class UsersAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var cursor = "cursor_example";  // string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) 
            var limit = 20;  // int? | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional)  (default to 20)
            var passThrough = new PassThroughQuery(); // PassThroughQuery | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads (optional) 
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // List users
                GetUsersResponse result = apiInstance.UsersAll(raw, consumerId, appId, serviceId, cursor, limit, passThrough, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.UsersAll: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	[optional]
limit	int?	Number of results to return. Minimum 1, Maximum 200, Default 20	[optional] [default to 20]
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	[optional]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetUsersResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Users	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersDelete

DeleteUserResponse UsersDelete (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Delete user

Delete user

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class UsersDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Delete user
                DeleteUserResponse result = apiInstance.UsersDelete(id, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.UsersDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

DeleteUserResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	User deleted	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersOne

GetUserResponse UsersOne (string id, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null, string fields = null)

Get user

Get user

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class UsersOneExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
            var fields = id,updated_at;  // string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional) 

            try
            {
                // Get user
                GetUserResponse result = apiInstance.UsersOne(id, consumerId, appId, serviceId, raw, fields);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.UsersOne: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields &quot;name&quot;, &quot;email&quot; and &quot;addresses.city&quot;. If any other fields are available, they will be excluded.	[optional]

Return type

GetUserResponse

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	User	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUpdate

UpdateUserResponse UsersUpdate (string id, User user, string consumerId = null, string appId = null, string serviceId = null, bool? raw = null)

Update user

Update user

Example

using System.Collections.Generic;
using System.Diagnostics;
using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example
{
    public class UsersUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://unify.apideck.com";
            // Configure API key authorization: apiKey
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new CrmApi(config);
            var id = "id_example";  // string | ID of the record you are acting upon.
            var user = new User(); // User | 
            var consumerId = test-consumer;  // string | ID of the consumer which you want to get or push data from (optional) 
            var appId = dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX;  // string | The ID of your Unify application (optional) 
            var serviceId = salesforce;  // string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) 
            var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)

            try
            {
                // Update user
                UpdateUserResponse result = apiInstance.UsersUpdate(id, user, consumerId, appId, serviceId, raw);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CrmApi.UsersUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
user	User
consumerId	string	ID of the consumer which you want to get or push data from	[optional]
appId	string	The ID of your Unify application	[optional]
serviceId	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	[optional]
raw	bool?	Include raw response. Mostly used for debugging purposes	[optional] [default to false]

Return type

UpdateUserResponse

Authorization

apiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	User updated	-
400	Bad Request	-
401	Unauthorized	-
402	Payment Required	-
404	The specified resource was not found	-
422	Unprocessable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]