LeadApi
Method: leadsAdd
Apideck->getLeadApi()->leadsAdd($data)| 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 |
\Apideck\Client\Model\CreateLeadResponse
| 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 |
<?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->getLeadApi()->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]
Method: leadsAll
Apideck->getLeadApi()->leadsAll($data)| 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 | |
| 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 |
\Apideck\Client\Model\GetLeadsResponse
| 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 |
<?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->getLeadApi()->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]
Method: leadsDelete
Apideck->getLeadApi()->leadsDelete($data)| 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 |
\Apideck\Client\Model\DeleteLeadResponse
| 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 |
<?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->getLeadApi()->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]
Method: leadsOne
Apideck->getLeadApi()->leadsOne($data)| 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 |
\Apideck\Client\Model\GetLeadResponse
| 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 |
<?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->getLeadApi()->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]
Method: leadsUpdate
Apideck->getLeadApi()->leadsUpdate($data)| 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 |
\Apideck\Client\Model\UpdateLeadResponse
| 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 |
<?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->getLeadApi()->leadsUpdate('id_example', $lead);
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}