Zendesk Sell Connector

Source API Docs API Changelog Connector Changelog

Description

Zendesk Sell is a sales force automation and CRM platform. This component allows managing leads, contacts, and deals in Zendesk Sell.

API Documentation

This component was built using the Zendesk Sell API.

Connections

OAuth 2.0

key: oauth

Create a connection of type OAuth 2.0 to authenticate with the Zendesk Sell API using OAuth 2.0.

Prerequisites

A Zendesk Sell account with administrator access

Setup Steps

Log in to the Zendesk Sell Dashboard at a URL similar to https://{subdomain}.zendesk.com/sales/dashboards/main.
On the left-hand side toolbar, click Settings.
Within the Settings section, navigate to Integrations > OAuth.
Under the OAuth section, open OAuth2 Settings.
In the Developer apps section, click Add Developer App.
Complete the required fields for the app setup. Specify the Redirect URL as https://oauth2.prismatic.io/callback.
Once the app has been added, select the details button associated with the app to retrieve the Client ID and Client Secret.

Configure the Connection

For Authorize URL, the default value is https://api.getbase.com/oauth2/authorize. Update if using a custom Zendesk Sell instance.
For Token URL, the default value is https://api.getbase.com/oauth2/token. Update if using a custom Zendesk Sell instance.
For Scopes, the default value is read write profile. Adjust based on the required level of access.
Enter the Client ID obtained from the developer app details.
Enter the Client Secret obtained from the developer app details.

Input	Notes	Example
Authorize URL	The OAuth 2.0 authorization endpoint for Zendesk Sell.	https://api.getbase.com/oauth2/authorize
Client ID	The client ID obtained from the Zendesk Sell OAuth application settings.
Client Secret	The client secret obtained from the Zendesk Sell OAuth application settings.
Scopes	The space-delimited OAuth 2.0 scopes to request. Defaults to read, write, and profile access.	read write profile
Token URL	The OAuth 2.0 token endpoint for Zendesk Sell.	https://api.getbase.com/oauth2/token

Triggers

New and Updated Records

Checks for new and updated records in a selected Zendesk Sell resource type on a configured schedule. | key: pollChangesTrigger

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Resource Type	The type of resource to poll for changes.
Show New Records	When true, newly created records will be included in the trigger output.	true
Show Updated Records	When true, records that were updated after the last poll will be included in the trigger output.	true

This trigger polls the Zendesk Sell API for new and updated records of a selected resource type on a scheduled basis.

How It Works

The trigger runs on the configured schedule
It fetches all records of the selected resource type using pagination, following next_page links until all pages are retrieved (100 records per page)
Records are filtered client-side: those with a created_at timestamp after the last poll are classified as new; those with an updated_at timestamp after the last poll but a created_at at or before it are classified as updated
The trigger updates its internal state after each poll, recording the current timestamp for use in the next comparison

Returned Data

Returns an object with two arrays: created for new records and updated for modified records.

Example Response (Polling)

{
  "data": {
    "created": [
      {
        "id": 1234567,
        "name": "Acme Corp Deal",
        "created_at": "2024-11-10T10:30:00Z",
        "updated_at": "2024-11-10T10:30:00Z"
      }
    ],
    "updated": [
      {
        "id": 7654321,
        "name": "Global Industries Deal",
        "created_at": "2024-11-08T09:00:00Z",
        "updated_at": "2024-11-10T14:22:00Z"
      }
    ]
  }
}

Fields shown are representative. The full response object includes additional properties.

Notes

All records are fetched on every poll and filtered in memory by timestamp. For large datasets, this may result in significant API usage and longer poll durations.
A record is classified as updated only if its created_at is at or before the last poll time. Records where both timestamps are after the last poll are classified as new, not updated.

Example Payload for New and Updated Records⤓

Loading…

Data Sources

Select Account

Select an account from your Zendesk Sell instance. | key: selectAccount | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Account⤓

Loading…

Select Contact

Select a contact from your Zendesk Sell account. | key: selectContact | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Contact⤓

Loading…

Select Deal

Select a deal from your Zendesk Sell account. | key: selectDeal | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Deal⤓

Loading…

Select Lead

Select a lead from your Zendesk Sell account. | key: selectLead | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Lead⤓

Loading…

Select Note

Select a note from your Zendesk Sell account. | key: selectNote | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Note⤓

Loading…

Select Order

Select an order from your Zendesk Sell account. | key: selectOrder | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Order⤓

Loading…

Select Pipeline

Select a pipeline from your Zendesk Sell account. | key: selectPipeline | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Pipeline⤓

Loading…

Select Product

Select a product from your Zendesk Sell account. | key: selectProduct | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Product⤓

Loading…

Select Stage

Select a stage from your Zendesk Sell account. | key: selectStage | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Stage⤓

Loading…

Select Task

Select a task from your Zendesk Sell account. | key: selectTask | type: picklist

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for Select Task⤓

Loading…

Actions

Create Contact

Creates a new contact. A contact may represent a single individual or an organization. | key: createContact

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Customer Status, Prospect Status, Title, Description, Industry, Owner ID, Contact ID, and Parent Organization ID.
Addresses	Physical, billing, and shipping addresses.
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
First Name	Set only when Is Organization is set to false (the contact is an individual).	John
Is Organization	This value can be set only during creation and cannot be changed later.
Last Name	Required only when Is Organization is set to false (the contact is an individual).	Doe
Organization Name	Required only when Is Organization is set to true.	Acme Corporation
Tags	Tags to apply.	important

Example Payload for Create Contact⤓

Loading…

Create Deal

Creates a new deal. | key: createDeal

Input	Notes	Example
Added At	Date and time that the deal was started in UTC (ISO8601 format).	2014-09-27T16:32:56Z
Connection	The Zendesk Sell connection to use.
Contact ID	The unique identifier of the primary contact associated with the deal.	87654321
Currency	The currency code for the deal value. If omitted, the account default currency is used.	USD
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
Customized Win Likelihood	User-provided win likelihood with value range 0-100.	75
Estimated Close Date	Expected date when the deal will close.	2024-06-30
Hot	Indicator of whether or not the deal is hot.
Last Stage Change At	Date and time when the deal was moved into the current stage in UTC (ISO8601 format).	2014-09-27T16:32:56Z
Loss Reason ID	The unique identifier of the reason the deal was marked as lost.	12345678
Name	A descriptive title identifying the deal in the pipeline.	Q1 Enterprise Deal
Owner ID	The unique identifier of the user who owns the deal.	12345678
Source ID	The unique identifier of the source that originated the deal.	12345678
Stage ID	The unique identifier of the pipeline stage for this deal.	12345678
Tags	Tags to apply.	important
Unqualified Reason ID	The unique identifier of the reason the deal was unqualified.	12345678
Value	Value of the deal in decimal format (e.g., two decimal places).	5000.00

Example Payload for Create Deal⤓

Loading…

Create Lead

Creates a new lead. | key: createLead

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Status, Title, Description, Industry, Owner ID, Source ID, and Unqualified Reason ID.
Address	The physical address of the lead in JSON format.	`{ "line1": "2726 Smith Street", "city": "Hyannis", "postal_code": "02601", "state": "MA", "country": "US" }`
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
First Name	The given name of an individual lead.	John
Last Name	The family name of an individual lead.	Doe
Organization Name	The company name. Required when the lead is an organization (when Last Name is empty).	Acme Corporation
Tags	Tags to apply.	important

Example Payload for Create Lead⤓

Loading…

Create Note

Creates a new note and associates it with one resource. | key: createNote

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Content	The body text of the note.	Highly important.
Is Important	When true, marks the note as important.
Resource ID	The unique identifier of the resource the note is attached to.	12345678
Resource Type	The type of resource the note is attached to. Possible values: lead, contact, deal.	lead
Tags	Tags to apply to the note.	premium
Type	The type of note. Possible values: regular or other types supported by the API.	regular

Example Payload for Create Note⤓

Loading…

Create Order

Creates a new order. | key: createOrder

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Deal ID	The unique identifier of the deal.	12345678
Discount	Overall discount on the order in percents. Defaults to 0.	50

Example Payload for Create Order⤓

Loading…

Create Task

Creates a new task. | key: createTask

Input	Notes	Example
Completed	When true, marks the task as completed.
Connection	The Zendesk Sell connection to use.
Content	The description or body of the task.	Contact Tom
Due Date	The date and time when the task is due. Format: ISO8601 UTC.	2014-09-27T16:32:56Z
Owner ID	Defaults to the unique identifier of the user who created the task.	12345678
Remind At	The date and time to send a reminder for this task. Format: ISO8601 UTC.	2014-09-29T15:32:56Z
Resource ID	The unique identifier of the resource the task is related to.	1
Resource Type	The type of resource the task is related to. Possible values: lead, contact, deal.	lead

Example Payload for Create Task⤓

Loading…

Delete Contact

Deletes an existing contact. This operation cannot be undone. | key: deleteContact

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Contact ID	The unique identifier of the contact.	12345678

Example Payload for Delete Contact⤓

Loading…

Delete Deal

Deletes an existing deal and removes all associated contacts from the deal in a single call. | key: deleteDeal

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Deal ID	The unique identifier of the deal.	12345678

Example Payload for Delete Deal⤓

Loading…

Delete Lead

Deletes an existing lead. | key: deleteLead

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Lead ID	The unique identifier of the lead.	12345678

Example Payload for Delete Lead⤓

Loading…

Delete Note

Deletes an existing note. This operation cannot be undone. | key: deleteNote

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Note ID	The unique identifier of the note.	12345678

Example Payload for Delete Note⤓

Loading…

Delete Order

Deletes an existing order and removes all associated line items in a single call. This operation cannot be undone. | key: deleteOrder

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Order ID	The unique identifier of the order.	12345678

Example Payload for Delete Order⤓

Loading…

Delete Task

Deletes an existing task. This operation cannot be undone. | key: deleteTask

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Task ID	The unique identifier of the task.	12345678

Example Payload for Delete Task⤓

Loading…

Get Contact

Returns a single contact available to the user, according to the unique contact ID provided. | key: getContact

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Contact ID	The unique identifier of the contact.	12345678

Example Payload for Get Contact⤓

Loading…

Get Contacts Stream

Reads the stream of contact events. | key: getContactsStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	The maximum number of events to return in a single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Contacts Stream⤓

Loading…

Get Custom Fields Stream

Reads the stream of custom field events. | key: getCustomFieldsStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	Limits maximum number of events in single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Custom Fields Stream⤓

Loading…

Get Deal

Returns a single deal available to the user. | key: getDeal

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Deal ID	The unique identifier of the deal.	12345678
Includes	Comma-separated list of one or more resources related to the deal. Possible values: associated_contacts.	associated_contacts

Example Payload for Get Deal⤓

Loading…

Get Deals Stream

Reads the stream of deal events. | key: getDealsStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	The maximum number of events to return in a single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Deals Stream⤓

Loading…

Get Lead

Returns a single lead available to the user. | key: getLead

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Lead ID	The unique identifier of the lead.	12345678

Example Payload for Get Lead⤓

Loading…

Get Leads Stream

Reads the stream of lead events. | key: getLeadsStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	The maximum number of events to return in a single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Leads Stream⤓

Loading…

Get Note

Returns a single note available to the user, according to the unique note ID provided. | key: getNote

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Note ID	The unique identifier of the note.	12345678

Example Payload for Get Note⤓

Loading…

Get Notes Stream

Reads the stream of note events. | key: getNotesStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	The maximum number of events to return in a single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Notes Stream⤓

Loading…

Get Order

Returns a single order available to the user. | key: getOrder

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Order ID	The unique identifier of the order.	12345678

Example Payload for Get Order⤓

Loading…

Get Orders Stream

Reads the stream of order events. | key: getOrdersStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	The maximum number of events to return in a single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Orders Stream⤓

Loading…

Get Products Stream

Reads the stream of product events. | key: getProductsStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	Limits maximum number of events in single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Products Stream⤓

Loading…

Get Stages Stream

Reads the stream of stage events. | key: getStagesStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	The maximum number of events to return in a single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Stages Stream⤓

Loading…

Get Stream

Provides a stream of changes to Zendesk Sell data. | key: getStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	Limits maximum number of events in single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top
Resource	The resource to get the stream for. Possible values: contacts, deals, leads.	contacts

Example Payload for Get Stream⤓

Loading…

Get Task

Returns a single task available to the user according to the unique task ID provided. | key: getTask

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Task ID	The unique identifier of the task.	12345678

Example Payload for Get Task⤓

Loading…

Get Tasks Stream

Reads the stream of task events. | key: getTasksStream

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Limit	The maximum number of events to return in a single response.	100
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.	top

Example Payload for Get Tasks Stream⤓

Loading…

List Account Details

Retrieves account details. | key: listAccountDetails

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

Example Payload for List Account Details⤓

Loading…

List Contacts

Returns all contacts available to the user according to the parameters provided. | key: listContacts

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Customer Status, Prospect Status, Contact IDs, Creator ID, Owner ID, Contact ID, Sort By, and Inclusive.
Primary Address	Street, city, state, postal code, and country.
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
First Name	Filters results to contacts with this given name.	John
Is Organization	Indicates whether or not this contact refers to an organization or an individual.
Last Name	Filters results to contacts with this family name.	Doe
Organization Name	Filters results to organization contacts with this company name.	Acme Corporation
Other Addresses	Billing and shipping addresses.
Pagination	Page and page-size controls.

Example Payload for List Contacts⤓

Loading…

List Custom Fields

Returns all custom fields associated with the specified resource type. | key: listCustomFields

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Resource Type	Specifies the type for which custom fields should be returned.

Example Payload for List Custom Fields⤓

Loading…

List Deals

Returns all deals available to the user. | key: listDeals

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Sort By, Includes, Inclusive, Value, Hot, and Estimated Close Date.
Connection	The Zendesk Sell connection to use.
Contact ID	Unique identifier of a primary contact.	87654321
Creator ID	Unique identifier of the user the deal was created by. Returns all deals created by the user.	12345678
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
IDs	Comma-separated list of deal IDs to be returned in a request.	12345678,87654321
Name	Filters results to deals whose name matches this value.	Q1 Enterprise Deal
Organization ID	Unique identifier of an organization.	12345678
Owner ID	Unique identifier of the user the deal is owned by. Returns all deals owned by the user.	12345678
Pagination	Page and page-size controls.
Source ID	Filters results to deals that originated from this source.	12345678
Stage ID	Filters results to deals currently in this pipeline stage.	12345678

Example Payload for List Deals⤓

Loading…

List Leads

Returns all leads available to the user. | key: listLeads

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Sort By and Inclusive.
Address	Street, city, state, postal code, and country.
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Creator ID	User ID. Returns all leads created by that user.	12345678
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
First Name	Filters results to leads with this given name.	John
IDs	Comma-separated list of lead IDs to be returned in a request.	12345678,87654321
Last Name	Filters results to leads with this family name.	Doe
Organization Name	Filters results to organization leads with this company name.	Acme Corporation
Owner ID	User ID. Returns all leads owned by that user.	12345678
Pagination	Page and page-size controls.
Source ID	Filters results to leads that originated from this source.	12345678
Status	Filters results to leads in this status (e.g. New).	New

Example Payload for List Leads⤓

Loading…

List Notes

Returns all notes available to the user, according to the parameters provided. | key: listNotes

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Sort By, Includes, and Query.
Connection	The Zendesk Sell connection to use.
Creator ID	Unique identifier of the user. Returns all notes created by the user.	12345678
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
IDs	Comma-separated list of note IDs to be returned in a request.	12345678,87654321
Pagination	Page and page-size controls.
Resource ID	The unique identifier of the resource the note is attached to.	12345678
Resource Type	Name of the type of resource to search for. Possible values: lead, contact, deal

Example Payload for List Notes⤓

Loading…

List Orders

Returns all orders available to the user. | key: listOrder

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Deal ID	The unique identifier of the deal the order is associated with.	12
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
IDs	Comma-separated list of IDs to be returned in request.	1,2,3
Pagination	Page and page-size controls.
Sort By	A field to sort by. Default ordering is ascending. To change the sort ordering to descending, append :desc to the field.	value:desc

Example Payload for List Orders⤓

Loading…

List Pipelines

Returns all pipelines available to the user, according to the parameters provided. | key: listPipelines

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Disabled	Parameter that determines whether to return disabled or enabled pipelines.	false
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
IDs	Comma-separated list of IDs to be returned in request.	1,2,3
Name	Name of the pipeline to search for. This parameter is used in a strict sense.	My Pipeline
Pagination	Page and page-size controls.
Sort By	Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The default ordering is ascending. To change the sort ordering to descending, append :desc to the field.	name:desc

Example Payload for List Pipelines⤓

Loading…

List Stages

Returns all stages available to the user. | key: listStages

Input	Notes	Example
Active	Parameter that determines whether to return active or inactive stages.
Connection	The Zendesk Sell connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
IDs	Comma-separated list of stage IDs to be returned in a request.	12345678,87654321
Name	Name of the stage to search for. This parameter is used in a strict sense.	Qualified
Pagination	Page and page-size controls.
Pipeline ID	The unique identifier of the pipeline that contains this stage.	12345678
Sort By	Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The default ordering is ascending. To change the sort ordering to descending, append :desc to the field. Possible values: pipeline_id, id, name, category, position, likelihood.	position:desc

Example Payload for List Stages⤓

Loading…

List Tasks

Returns all tasks available to the user. | key: listTasks

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Sort By, Query, Resource Type, Resource ID, IDs, Creator ID, Owner ID, Overdue, and Remind.
Completed	Indicates whether the query will return tasks that are completed or not.
Connection	The Zendesk Sell connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination. Page and Per Page inputs are ignored when this is enabled.	false
Pagination	Page and page-size controls.
Type	Type of tasks to search for. Possible values: floating, related.	floating

Example Payload for List Tasks⤓

Loading…

Raw Request

Sends a raw HTTP request to the Zendesk Sell API. | key: rawRequest

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	This is the URL to call.	/tasks
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
API Version	The version of the API to use.	v2

Example Payload for Raw Request⤓

Loading…

Update Contact

Updates contact information. If the specified contact does not exist, the request will return an error. | key: updateContact

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Customer Status, Prospect Status, Title, Description, Industry, Owner ID, Contact ID, and Parent Organization ID.
Addresses	Physical, billing, and shipping addresses.
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
First Name	Set only when Is Organization is set to false (the contact is an individual).	John
Contact ID	The unique identifier of the contact.	12345678
Last Name	Set only when Is Organization is set to false (the contact is an individual).	Doe
Organization Name	The full company name, used when the contact is an organization.	Acme Corporation
Tags	Tags to apply.	important

Example Payload for Update Contact⤓

Loading…

Update Deal

Updates deal information. | key: updateDeal

Input	Notes	Example
Added At	Date and time that the deal was started in UTC (ISO8601 format).	2014-09-27T16:32:56Z
Connection	The Zendesk Sell connection to use.
Contact ID	Unique identifier of a primary contact.	87654321
Currency	The currency code for the deal value. If omitted, the account default currency is used.	USD
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
Customized Win Likelihood	User-provided win likelihood with value range 0-100.	75
Estimated Close Date	Expected date when the deal will close.	2024-06-30
Hot	Indicator of whether or not the deal is hot.
Deal ID	The unique identifier of the deal.	12345678
Last Stage Change At	Date and time when the deal was moved into the current stage in UTC (ISO8601 format).	2014-09-27T16:32:56Z
Loss Reason ID	The unique identifier of the reason the deal was marked as lost.	12345678
Name	A descriptive title identifying the deal in the pipeline.	Q1 Enterprise Deal
Owner ID	The unique identifier of the user who owns the deal.	12345678
Source ID	The unique identifier of the source that originated the deal.	12345678
Stage ID	The unique identifier of the pipeline stage for this deal.	12345678
Tags	Tags to apply.	important
Unqualified Reason ID	The unique identifier of the reason the deal was unqualified.	12345678
Value	Value of the deal in decimal format (e.g., two decimal places).	5000.00

Example Payload for Update Deal⤓

Loading…

Update Lead

Updates lead information. | key: updateLead

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Status, Title, Description, Industry, Owner ID, Source ID, and Unqualified Reason ID.
Address	The physical address of the lead in JSON format.	`{ "line1": "2726 Smith Street", "city": "Hyannis", "postal_code": "02601", "state": "MA", "country": "US" }`
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
First Name	The given name of an individual lead.	John
Lead ID	The unique identifier of the lead.	12345678
Last Name	The family name of an individual lead.	Doe
Organization Name	The company name. Required when the lead is an organization (when Last Name is empty).	Acme Corporation
Tags	Tags to apply.	important

Example Payload for Update Lead⤓

Loading…

Update Note

Updates note information. | key: updateNote

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Content	The body text of the note.	Highly important.
Is Important	When true, marks the note as important.
Resource ID	The unique identifier of the resource the note is attached to.	12345678
Resource Type	The type of resource the note is attached to. Possible values: lead, contact, deal.	lead
Tags	Tags to apply to the note.	premium
Type	The type of note. Possible values: regular or other types supported by the API.	regular

Example Payload for Update Note⤓

Loading…

Update Order

Updates order information. | key: updateOrder

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Discount	Overall discount on the order in percents.	25
Order ID	The unique identifier of the order.	12345678

Example Payload for Update Order⤓

Loading…

Update Task

Updates task information. | key: updateTask

Input	Notes	Example
Completed	When true, marks the task as completed.
Connection	The Zendesk Sell connection to use.
Content	The description or body of the task.	Contact Tom
Due Date	The date and time when the task is due. Format: ISO8601 UTC.	2014-09-27T16:32:56Z
Task ID	The unique identifier of the task.	12345678
Owner ID	Defaults to the unique identifier of the user who created the task.	12345678
Remind At	The date and time to send a reminder for this task. Format: ISO8601 UTC.	2014-09-29T15:32:56Z
Resource ID	The unique identifier of the resource the task is related to.	1
Resource Type	The type of resource the task is related to. Possible values: lead, contact, deal.	lead

Example Payload for Update Task⤓

Loading…

Upsert Contact

Creates a new contact or updates an existing one based on a filter value or set of filters. At least one filter query parameter is required. | key: upsertContact

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Customer Status, Prospect Status, Inclusive, Creator ID, Owner ID, Contact ID, and Parent Organization ID.
Addresses	Physical, billing, and shipping addresses.
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
Filters	Custom-field filters to match against.	key: custom_fields[referral_website] value: https://www.test.com
First Name	Set only when Is Organization is set to false (the contact is an individual).	John
Is Organization	This value can be set only during creation and cannot be changed later.
Last Name	Set only when Is Organization is set to false (the contact is an individual).	Doe
Organization Name	The full company name, used when the contact is an organization.	Acme Corporation

Example Payload for Upsert Contact⤓

Loading…

Upsert Lead

Creates a new lead or updates an existing one based on a filter value or set of filters. | key: upsertLead

Input	Notes	Example
Additional Fields	Additional optional fields for the request. Includes: Status, Inclusive, Creator ID, Owner ID, and Source ID.
Addresses	Physical, billing, and shipping addresses.
Connection	The Zendesk Sell connection to use.
Contact Information	Email, phone, and other contact channel details.
Custom Fields	Custom field key-value pairs.	key: external_id value: SKU01
Filters	Custom-field filters to match against.	key: custom_fields[referral_website] value: https://www.test.com
First Name	The given name of an individual lead.	John
Last Name	The family name of an individual lead.	Doe
Organization Name	The company name. Required when the lead is an organization (when Last Name is empty).	Acme Corporation

Example Payload for Upsert Lead⤓

Loading…

Changelog

2026-07-01

Restructured action inputs into structured objects for an improved user experience.

Contact and Lead create, update, and upsert actions group their contact-channel and address inputs into Contact Information and Addresses
List actions (List Contacts, List Leads, List Deals, List Notes, List Tasks, List Orders, List Pipelines, List Stages) group their inputs into Pagination and Additional Fields, where Additional Fields holds optional query controls such as sort and match-mode; Fetch All stays a top-level toggle

2026-05-28

Added Fetch All input to list actions to automatically retrieve all pages of results in a single call:

List Contacts
List Deals
List Leads
List Notes
List Orders
List Pipelines
List Stages
List Tasks

2026-05-20

Applied automated security patches and code formatting updates

2026-04-30

Updated spectral version

2026-04-21

Added New and Updated Records polling trigger that checks for new and updated deals, leads, contacts, tasks, or notes in Zendesk Sell on a configured schedule

2026-04-07

Added global debug support across all actions for improved troubleshooting

2026-03-31

Various modernizations and documentation updates

2026-03-05

Added inline data sources for contacts, deals, leads, notes, orders, and tasks to enhance data selection capabilities

Zendesk Sell Connector

Description​

API Documentation​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

New and Updated Records​

How It Works​

Returned Data​

Notes​

Data Sources​

Select Account​

Select Contact​

Select Deal​

Select Lead​

Select Note​

Select Order​

Select Pipeline​

Select Product​

Select Stage​

Select Task​

Actions​

Create Contact​

Create Deal​

Create Lead​

Create Note​

Create Order​

Create Task​

Delete Contact​

Delete Deal​

Delete Lead​

Delete Note​

Delete Order​

Delete Task​

Get Contact​

Get Contacts Stream​

Get Custom Fields Stream​

Get Deal​

Get Deals Stream​

Get Lead​

Get Leads Stream​

Get Note​

Get Notes Stream​

Get Order​

Get Orders Stream​

Get Products Stream​

Get Stages Stream​

Get Stream​

Get Task​

Get Tasks Stream​

List Account Details​

List Contacts​

List Custom Fields​

List Deals​

List Leads​

List Notes​

List Orders​

List Pipelines​

List Stages​

List Tasks​

Raw Request​

Update Contact​

Update Deal​

Update Lead​

Update Note​

Update Order​

Update Task​

Upsert Contact​

Upsert Lead​

Changelog​

2026-07-01​

2026-05-28​

2026-05-20​

2026-04-30​

2026-04-21​

2026-04-07​

2026-03-31​

Description

API Documentation

Connections

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Triggers

New and Updated Records

How It Works

Returned Data

Notes

Data Sources

Select Account

Select Contact

Select Deal

Select Lead

Select Note

Select Order

Select Pipeline

Select Product

Select Stage

Select Task

Actions

Create Contact

Create Deal

Create Lead

Create Note

Create Order

Create Task

Delete Contact

Delete Deal

Delete Lead

Delete Note

Delete Order

Delete Task

Get Contact

Get Contacts Stream

Get Custom Fields Stream

Get Deal

Get Deals Stream

Get Lead

Get Leads Stream

Get Note

Get Notes Stream

Get Order

Get Orders Stream

Get Products Stream

Get Stages Stream

Get Stream

Get Task

Get Tasks Stream

List Account Details

List Contacts

List Custom Fields

List Deals

List Leads

List Notes

List Orders

List Pipelines

List Stages

List Tasks

Raw Request

Update Contact

Update Deal

Update Lead

Update Note

Update Order

Update Task

Upsert Contact

Upsert Lead

Changelog

2026-07-01

2026-05-28

2026-05-20

2026-04-30

2026-04-21

2026-04-07

2026-03-31

2026-03-05