Apideck.Crm

Class Name

CrmApi

Methods

Create Activity
List Activities
Delete Activity
Get Activity
Update Activity
Create Company
List Companies
Delete Company
Get Company
Update Company
Create Contact
List Contacts
Delete Contact
Get Contact
Update Contact
Create Lead
List Leads
Delete Lead
Get Lead
Update Lead
Create Note
List Notes
Delete Note
Get Note
Update Note
Create Opportunity
List Opportunities
Delete Opportunity
Get Opportunity
Update Opportunity
Create Pipeline
List Pipelines
Delete Pipeline
Get Pipeline
Update Pipeline
Create User
List Users
Delete User
Get User
Update User

Create Activity

Method: activitiesAdd

Apideck->getCrmApi()->activitiesAdd($data)

Parameters

Name	Type	Description	Notes
activity	\Apideck\Client\Model\Activity
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateActivityResponse

HTTP response details

Status code	Description
201	Activity created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->activitiesAdd($activity);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Activities

Method: activitiesAll

Apideck->getCrmApi()->activitiesAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
filter	\Apideck\Client\Model\ActivitiesFilter	Apply filters
sort	\Apideck\Client\Model\ActivitiesSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetActivitiesResponse

HTTP response details

Status code	Description
200	Activities
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->activitiesAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete Activity

Method: activitiesDelete

Apideck->getCrmApi()->activitiesDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteActivityResponse

HTTP response details

Status code	Description
200	Activity deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->activitiesDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Activity

Method: activitiesOne

Apideck->getCrmApi()->activitiesOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetActivityResponse

HTTP response details

Status code	Description
200	Activity
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->activitiesOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update Activity

Method: activitiesUpdate

Apideck->getCrmApi()->activitiesUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
activity	\Apideck\Client\Model\Activity
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateActivityResponse

HTTP response details

Status code	Description
200	Activity updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->activitiesUpdate('id_example', $activity);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Create Company

Method: companiesAdd

Apideck->getCrmApi()->companiesAdd($data)

Parameters

Name	Type	Description	Notes
company	\Apideck\Client\Model\Company
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateCompanyResponse

HTTP response details

Status code	Description
201	Company created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->companiesAdd($company);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Companies

Method: companiesAll

Apideck->getCrmApi()->companiesAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
filter	\Apideck\Client\Model\CompaniesFilter	Apply filters
sort	\Apideck\Client\Model\CompaniesSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetCompaniesResponse

HTTP response details

Status code	Description
200	Companies
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->companiesAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete Company

Method: companiesDelete

Apideck->getCrmApi()->companiesDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteCompanyResponse

HTTP response details

Status code	Description
200	Company deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->companiesDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Company

Method: companiesOne

Apideck->getCrmApi()->companiesOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetCompanyResponse

HTTP response details

Status code	Description
200	Company
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->companiesOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update Company

Method: companiesUpdate

Apideck->getCrmApi()->companiesUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
company	\Apideck\Client\Model\Company
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateCompanyResponse

HTTP response details

Status code	Description
200	Company updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->companiesUpdate('id_example', $company);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Create Contact

Method: contactsAdd

Apideck->getCrmApi()->contactsAdd($data)

Parameters

Name	Type	Description	Notes
contact	\Apideck\Client\Model\Contact
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateContactResponse

HTTP response details

Status code	Description
201	Contact created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->contactsAdd($contact);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Contacts

Method: contactsAll

Apideck->getCrmApi()->contactsAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
filter	\Apideck\Client\Model\ContactsFilter	Apply filters
sort	\Apideck\Client\Model\ContactsSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetContactsResponse

HTTP response details

Status code	Description
200	Contacts
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->contactsAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete Contact

Method: contactsDelete

Apideck->getCrmApi()->contactsDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteContactResponse

HTTP response details

Status code	Description
200	Contact deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->contactsDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Contact

Method: contactsOne

Apideck->getCrmApi()->contactsOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
filter	\Apideck\Client\Model\ContactsFilter	Apply filters
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetContactResponse

HTTP response details

Status code	Description
200	Contact
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->contactsOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update Contact

Method: contactsUpdate

Apideck->getCrmApi()->contactsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
contact	\Apideck\Client\Model\Contact
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateContactResponse

HTTP response details

Status code	Description
200	Contact updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->contactsUpdate('id_example', $contact);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Create Lead

Method: leadsAdd

Apideck->getCrmApi()->leadsAdd($data)

Parameters

Name	Type	Description	Notes
lead	\Apideck\Client\Model\Lead
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateLeadResponse

HTTP response details

Status code	Description
201	Lead created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->leadsAdd($lead);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Leads

Method: leadsAll

Apideck->getCrmApi()->leadsAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
filter	\Apideck\Client\Model\LeadsFilter	Apply filters
sort	\Apideck\Client\Model\LeadsSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetLeadsResponse

HTTP response details

Status code	Description
200	Leads
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->leadsAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete Lead

Method: leadsDelete

Apideck->getCrmApi()->leadsDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteLeadResponse

HTTP response details

Status code	Description
200	Lead deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->leadsDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Lead

Method: leadsOne

Apideck->getCrmApi()->leadsOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetLeadResponse

HTTP response details

Status code	Description
200	Lead
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->leadsOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update Lead

Method: leadsUpdate

Apideck->getCrmApi()->leadsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
lead	\Apideck\Client\Model\Lead
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateLeadResponse

HTTP response details

Status code	Description
200	Lead updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->leadsUpdate('id_example', $lead);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Create Note

Method: notesAdd

Apideck->getCrmApi()->notesAdd($data)

Parameters

Name	Type	Description	Notes
note	\Apideck\Client\Model\Note
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateNoteResponse

HTTP response details

Status code	Description
201	Note created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->notesAdd($note);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Notes

Method: notesAll

Apideck->getCrmApi()->notesAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetNotesResponse

HTTP response details

Status code	Description
200	Notes
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->notesAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete Note

Method: notesDelete

Apideck->getCrmApi()->notesDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteNoteResponse

HTTP response details

Status code	Description
200	Note deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->notesDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Note

Method: notesOne

Apideck->getCrmApi()->notesOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetNoteResponse

HTTP response details

Status code	Description
200	Note
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->notesOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update Note

Method: notesUpdate

Apideck->getCrmApi()->notesUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
note	\Apideck\Client\Model\Note
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateNoteResponse

HTTP response details

Status code	Description
200	Note updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->notesUpdate('id_example', $note);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Create Opportunity

Method: opportunitiesAdd

Apideck->getCrmApi()->opportunitiesAdd($data)

Parameters

Name	Type	Description	Notes
opportunity	\Apideck\Client\Model\Opportunity
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateOpportunityResponse

HTTP response details

Status code	Description
201	Opportunity created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->opportunitiesAdd($opportunity);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Opportunities

Method: opportunitiesAll

Apideck->getCrmApi()->opportunitiesAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
filter	\Apideck\Client\Model\OpportunitiesFilter	Apply filters
sort	\Apideck\Client\Model\OpportunitiesSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetOpportunitiesResponse

HTTP response details

Status code	Description
200	Opportunities
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->opportunitiesAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete Opportunity

Method: opportunitiesDelete

Apideck->getCrmApi()->opportunitiesDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteOpportunityResponse

HTTP response details

Status code	Description
200	Opportunity deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->opportunitiesDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Opportunity

Method: opportunitiesOne

Apideck->getCrmApi()->opportunitiesOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetOpportunityResponse

HTTP response details

Status code	Description
200	Opportunity
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->opportunitiesOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update Opportunity

Method: opportunitiesUpdate

Apideck->getCrmApi()->opportunitiesUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
opportunity	\Apideck\Client\Model\Opportunity
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateOpportunityResponse

HTTP response details

Status code	Description
200	Opportunity updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->opportunitiesUpdate('id_example', $opportunity);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Create Pipeline

Method: pipelinesAdd

Apideck->getCrmApi()->pipelinesAdd($data)

Parameters

Name	Type	Description	Notes
pipeline	\Apideck\Client\Model\Pipeline
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreatePipelineResponse

HTTP response details

Status code	Description
201	Pipeline created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->pipelinesAdd($pipeline);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Pipelines

Method: pipelinesAll

Apideck->getCrmApi()->pipelinesAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetPipelinesResponse

HTTP response details

Status code	Description
200	Pipelines
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->pipelinesAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete Pipeline

Method: pipelinesDelete

Apideck->getCrmApi()->pipelinesDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeletePipelineResponse

HTTP response details

Status code	Description
200	Pipeline deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->pipelinesDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Pipeline

Method: pipelinesOne

Apideck->getCrmApi()->pipelinesOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetPipelineResponse

HTTP response details

Status code	Description
200	Pipeline
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->pipelinesOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update Pipeline

Method: pipelinesUpdate

Apideck->getCrmApi()->pipelinesUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
pipeline	\Apideck\Client\Model\Pipeline
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdatePipelineResponse

HTTP response details

Status code	Description
200	Pipeline updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->pipelinesUpdate('id_example', $pipeline);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Create User

Method: usersAdd

Apideck->getCrmApi()->usersAdd($data)

Parameters

Name	Type	Description	Notes
user	\Apideck\Client\Model\User
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateUserResponse

HTTP response details

Status code	Description
201	User created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->usersAdd($user);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Users

Method: usersAll

Apideck->getCrmApi()->usersAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetUsersResponse

HTTP response details

Status code	Description
200	Users
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->usersAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Delete User

Method: usersDelete

Apideck->getCrmApi()->usersDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteUserResponse

HTTP response details

Status code	Description
200	User deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->usersDelete('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get User

Method: usersOne

Apideck->getCrmApi()->usersOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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. Example: `fields=name,email,addresses.city` 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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetUserResponse

HTTP response details

Status code	Description
200	User
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->usersOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Update User

Method: usersUpdate

Apideck->getCrmApi()->usersUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
user	\Apideck\Client\Model\User
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateUserResponse

HTTP response details

Status code	Description
200	User updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getCrmApi()->usersUpdate('id_example', $user);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Files

CrmApi.md

Latest commit

History

CrmApi.md

File metadata and controls

Apideck.Crm

Class Name

Methods

Create Activity

Parameters

Response Type

HTTP response details

Example Usage

List Activities

Parameters

Response Type

HTTP response details

Example Usage

Delete Activity

Parameters

Response Type

HTTP response details

Example Usage

Get Activity

Parameters

Response Type

HTTP response details

Example Usage

Update Activity

Parameters

Response Type

HTTP response details

Example Usage

Create Company

Parameters

Response Type

HTTP response details

Example Usage

List Companies

Parameters

Response Type

HTTP response details

Example Usage

Delete Company

Parameters

Response Type

HTTP response details

Example Usage

Get Company

Parameters

Response Type

HTTP response details

Example Usage

Update Company

Parameters

Response Type

HTTP response details

Example Usage

Create Contact

Parameters

Response Type

HTTP response details

Example Usage

List Contacts

Parameters

Response Type

HTTP response details

Example Usage

Delete Contact

Parameters

Response Type

HTTP response details

Example Usage

Get Contact

Parameters

Response Type

HTTP response details

Example Usage

Update Contact