Leads
The Leads model
List leads
List leads
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Apply filters (beta)
Apply sorting (beta)
Responses
Mapping coverage per connector















Request example
Response example
Create lead
Create lead
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonlanguage code according to ISO 639-1. For the United States - EN
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Responses
Mapping coverage per connector















Request example
Response example
Get lead
Get lead
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector















Request example
Response example
Update lead
Update lead
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonlanguage code according to ISO 639-1. For the United States - EN
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Responses
Mapping coverage per connector















Request example
Response example
Delete lead
Delete lead
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector















Request example
Response example
Lead CreatedWebhook
Lead Created
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses















Request example
Lead UpdatedWebhook
Lead Updated
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses















Request example
Lead DeletedWebhook
Lead Deleted
Header parameters
The type of event that was triggered
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses















Request example