Zendesk Sell Connector

Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

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

Authenticate using OAuth 2.0.

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.flowbuilder.eu.lansweeper.com/callback for EU sites or https://oauth2.flowbuilder.us.lansweeper.com/callback for US sites.
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.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Input	Comments	Default
Authorize URL	The OAuth 2.0 authorization endpoint for Zendesk Sell.	https://api.getbase.com/oauth2/authorize
Token URL	The OAuth 2.0 token endpoint for Zendesk Sell.	https://api.getbase.com/oauth2/token
Scopes	The space-delimited OAuth 2.0 scopes to request. Defaults to read, write, and profile access.	read write profile
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.

Triggers

New and Updated Records

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

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

Actions

Create Contact

Creates a new contact. A contact may represent a single individual or an organization.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Name	Required only if the contact is an organization. is_organization is set to true.
First Name	The field will be set only if the contact is an individual. is_organization is set to false.
Last Name	Required only if the contact is an individual. is_organization is set to false.
Owner ID	Defaults to the unique identifier of the user who created the contact.
Is Organization	This value can be set only during creation and cannot be changed later.
Contact ID	The field will be set only if the contact is an individual. is_organization is set to false.
Parent Organization ID	The unique identifier of a contact that should be set as parent for this organization. Referenced contact also has to be an organization. It can be set only for organization contacts (is_organization set to true).
Customer Status	Customer status of the contact. Possible values: none, current, past.
Prospect Status	Prospect status of the contact. Possible values: none, current, lost.
Title	Job title of the contact.
Description	Additional notes or details about the contact.
Industry	Industry classification of the contact.
Website	Website URL of the contact.
Email	Email address of the contact.
Phone	Phone number of the contact.
Mobile	Mobile phone number of the contact.
Fax	Fax number of the contact.
Twitter	Twitter username of the contact.
Facebook	Facebook username of the contact.
LinkedIn	LinkedIn username of the contact.
Skype	Skype username of the contact.
Address	Physical address of the contact.
Billing Address	Billing address of the contact. null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details).
Shipping Address	Shipping address of the contact. null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details).
Tag	Tags to apply to the contact. You need to supply the entire set.
Custom Field	Filterable custom field key-value pairs.

Create Deal

Creates a new deal.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Name	Name of the deal.
Contact ID	The unique identifier of the primary contact associated with the deal.
Value	Value of the deal in decimal format (e.g., two decimal places).
Currency	The currency code for the deal value. If omitted, the account default currency is used.
Owner ID	Defaults to the unique identifier of the user that the deal is created by.
Hot	Indicator of whether or not the deal is hot.
Stage ID	If omitted, the deal will be placed in the first stage of the default pipeline.
Last Stage Change At	Date and time when the deal was moved into the current stage in UTC (ISO8601 format).
Added At	Date and time that the deal was started in UTC (ISO8601 format).
Source ID	ID of the deal Source.
Loss Reason ID	ID of the Loss Reason.
Unqualified Reason ID	ID of the Unqualify Reason.
Estimated Close Date	Expected date when the deal will close.
Customized Win Likelihood	User-provided win likelihood with value range 0-100.
Tag	Tags to apply. You need to supply the entire set.
Custom Field	Filterable custom field key-value pairs.

Create Lead

Creates a new lead.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Last Name	Required only if a lead is an individual. company_name is empty.
Organization Name	Required only if a lead is an organization. last_name is empty.
First Name	First name of the contact.
Owner ID	Defaults to user's unique identifier of the user who created the lead is created by.
Status	Status of the lead.
Source ID	The unique identifier of the lead source.
Unqualified Reason ID	The unique identifier of the reason the lead was unqualified.
Title	Job title or role.
Description	Description or notes.
Industry	Industry classification.
Website	Website URL.
Email	Email address.
Phone	Phone number.
Mobile	Mobile phone number.
Fax	Fax number.
Twitter	Twitter username.
Facebook	Facebook username.
LinkedIn	LinkedIn username.
Skype	Skype username.
Address	The physical address of the lead in JSON format.
Tag	Tags to apply. You need to supply the entire set.
Custom Field	Filterable custom field key-value pairs.

Create Note

Creates a new note and associates it with one resource.

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

Create Order

Creates a new order.

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

Create Task

Creates a new task.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Content	The description or body of the task.
Due Date	The date and time when the task is due. Format: ISO8601 UTC.
Owner ID	Defaults to the unique identifier of the user who created the task.
Resource Type	The type of resource the task is related to. Possible values: lead, contact, deal.
Resource ID	The unique identifier of the resource the task is related to.
Completed	When true, marks the task as completed.
Remind At	The date and time to send a reminder for this task. Format: ISO8601 UTC.

Delete Contact

Deletes an existing contact. This operation cannot be undone.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Contact ID	The unique identifier of the contact to delete.

Delete Deal

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

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Deal ID	The unique identifier of the deal to delete.

Delete Lead

Deletes an existing lead.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Lead ID	The unique identifier of the lead to delete.

Delete Note

Deletes an existing note. This operation cannot be undone.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Note ID	Unique identifier of the note.

Delete Order

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

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Order ID	The unique identifier of the order to delete.

Delete Task

Deletes an existing task. This operation cannot be undone.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Task ID	The unique identifier of the task to delete.

Get Contact

Returns a single contact available to the user, according to the unique contact ID provided.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Contact ID	The unique identifier of the contact to retrieve.

Get Contacts Stream

Reads the stream of contact events.

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

Get Custom Fields Stream

Reads the stream of custom field events.

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

Get Deal

Returns a single deal available to the user.

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

Get Deals Stream

Reads the stream of deal events.

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

Get Lead

Returns a single lead available to the user.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Lead ID	The unique identifier of the lead to retrieve.

Get Leads Stream

Reads the stream of lead events.

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

Get Note

Returns a single note available to the user, according to the unique note ID provided.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Note ID	The unique identifier of the note.

Get Notes Stream

Reads the stream of note events.

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

Get Order

Returns a single order available to the user.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Order ID	The unique identifier of the order to retrieve.

Get Orders Stream

Reads the stream of order events.

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

Get Products Stream

Reads the stream of product events.

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

Get Stages Stream

Reads the stream of stage events.

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

Get Stream

Provides a stream of changes to Zendesk Sell data.

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

Get Task

Returns a single task available to the user according to the unique task ID provided.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Task ID	The unique identifier of the task to retrieve.

Get Tasks Stream

Reads the stream of task events.

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

List Account Details

Retrieves account details.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.

List Contacts

Returns all contacts available to the user according to the parameters provided.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
Sort By	A field to sort by. You can sort by filterable custom fields as well.
IDs	Comma-separated list of the IDs for the contacts you want to be returned in your request.
Creator ID	User ID. Returns all contacts created by that user.
Owner ID	User ID. Returns all contacts owned by that user.
Is Organization	Indicates whether or not this contact refers to an organization or an individual.
Contact ID	The unique identifier of the organization that the contact belongs to.
Name	Name of the contact.
First Name	First name of the contact.
Last Name	Last name of the contact.
Email	Email address of the contact.
Phone	Phone number of the contact.
Mobile	Mobile phone number of the contact.
Customer Status	Customer status of the contact. Possible values: none, current, past
Prospect Status	Prospect status of the contact. Possible values: none, current, lost
Address (City)	City name.
Address (Postal Code)	Zip code or equivalent
Address (Country)	Country name.
Address (State)	State/region name.
Billing Address	null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details).
Shipping Address	null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details).
Custom Field	Filterable custom field key-value pairs.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Page	The page number to start from. Page numbering is 1-based and omitting the page parameter will return the first page.
Per Page	The number of records to return per page. Default limit is 25 and maximum number that can be returned is 100.

List Custom Fields

Returns all custom fields associated with the specified resource type.

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

List Deals

Returns all deals available to the user.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
Sort By	A field to sort by. You can sort by filterable custom fields as well.
IDs	Comma-separated list of deal IDs to be returned in a request.
Includes	Comma-separated list of one or more resources related to a deal.
Creator ID	Unique identifier of the user the deal was created by. Returns all deals created by the user.
Owner ID	Unique identifier of the user the deal is owned by. Returns all deals owned by the user.
Contact ID	Unique identifier of a primary contact.
Organization ID	Unique identifier of an organization.
Hot	Indicator of whether or not the deal is hot.
Source ID	ID of the Source.
Stage ID	ID of the Stage.
Name	Name of the deal.
Value	Value of the deal. We encourage you to use a string with two decimal places.
Estimated Close Date	Estimated close date of the deal.
Custom Field	Filterable custom field key-value pairs.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Page	Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.
Per Page	Number of records to return per page. Default limit is 25 and the maximum number that can be returned is 100.

List Leads

Returns all leads available to the user.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
Sort By	A field to sort by. You can sort by filterable custom fields as well.
IDs	Comma-separated list of lead IDs to be returned in a request.
Creator ID	User ID. Returns all leads created by that user.
Owner ID	User ID. Returns all leads owned by that user.
Source ID	ID of the Source.
First Name	First name of the lead.
Last Name	Last name of the lead.
Organization Name	Organization name of the lead.
Status	Status of the lead.
Email	Email address of the lead.
Phone	Phone number of the lead.
Mobile	Mobile phone number of the lead.
Address[city]	City name.
Address[postal Code]	Zip or Postal code.
Address[state]	State/region name.
Address[country]	Country name.
Custom Field	Filterable custom field key-value pairs.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Page	Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page.
Per Page	Number of records to return per page. The default limit is 25 and the maximum number that can be returned is 100.

List Notes

Returns all notes available to the user, according to the parameters provided.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
Sort By	A field to sort by. Default ordering is ascending. If you want to change the sort ordering to descending, append :desc to the field e.g. sort_by=resource_type:desc. Possible values, resource_type, created_at, updated_at
Includes	Comma-separated list of one or more resources related to the note. Not supported at the moment.
IDs	Comma-separated list of note IDs to be returned in a request.
Creator ID	Unique identifier of the user. Returns all notes created by the user.
Q	A query string to search for. Performs a full text search on the content field.
Resource Type	Name of the type of resource to search for. Possible values: lead, contact, deal
Resource ID	Unique identifier of the resource to search for.
Page	Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.
Per Page	Number of records to return per page. The default limit is 25 and the maximum number that can be returned at one time is 100.

List Orders

Returns all orders available to the user.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
IDs	Comma-separated list of IDs to be returned in request.
Sort By	A field to sort by. Default ordering is ascending. If you want to change the sort ordering to descending, append :desc to the field.
Deal ID	ID of the deal order is associated to.
Page	Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.
Per Page	Number of records to return per page. Defaults to 25. Maximum is 500.

List Pipelines

Returns all pipelines available to the user, according to the parameters provided.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
IDs	Comma-separated list of IDs to be returned in request.
Sort By	Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The default ordering is ascending. If you want to change the sort ordering to descending, append :desc to the field.
Name	Name of the pipeline to search for. This parameter is used in a strict sense.
Disabled	Parameter that determines whether to return disabled or enabled pipelines.
Page	Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.
Per Page	Number of records to return per page. Default limit is 25 and the maximum number that can be returned is 100.

List Stages

Returns all stages available to the user.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
Pipeline ID	The unique identifier of the pipeline that contains this stage.
Sort By	Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The default ordering is ascending. If you want to change the sort ordering to descending, append :desc to the field. Possible values: pipeline_id, id, name, category, position, likelihood
IDs	Comma-separated list of stage IDs to be returned in a request.
Name	Name of the stage you're searching for. This parameter is used in a strict sense.
Active	Parameter that determines whether to return active or inactive stages.
Page	The page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.
Per Page	The number of records to return per page. The default limit is 25 and the maximum number that can be returned is 100.

List Tasks

Returns all tasks available to the user.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Fetch All	When enabled, automatically fetches all pages of results. Page and Per Page inputs are ignored when this is enabled.	false
Sort By	A field to sort by. The default ordering is ascending. If you want to change the sort order to descending, append :desc to the field
IDs	Comma-separated list of task IDs to be returned in a request.
Creator ID	Unique identifier of the user. Returns all tasks created by the user.
Owner ID	Unique identifier of the user. Returns all tasks owned by the user.
Q	A query string to search for. Performs a full text search on the content field.
Type	Type of tasks to search for. Possible values: floating, related
Resource Type	Name of the resource type to search for. Possible values: lead, contact, deal
Resource ID	Unique identifier of the resource that you're searching for.
Completed	Indicates whether the query will return tasks that are completed or not.
Overdue	Indicates whether the query will return tasks where the due_date parameter has been passed or not.
Remind	Indicates whether the query will return tasks with reminders or without reminders.
Page	Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page.
Per Page	Number of records to return per page. The default limit is 25 and the maximum number that can be returned is 100.

Raw Request

Sends a raw HTTP request to the Zendesk Sell API.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
URL	This is the URL to call.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
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.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
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
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
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

Update Contact

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

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
ID	The unique identifier of the contact.
Name	This field will be set only if the contact is an organization. is_organization is set to true.
First Name	The field will be set only if the contact is an individual. is_organization is set to false.
Last Name	The field will be set only if the contact is an individual. is_organization is set to false.
Contact ID	The field will be set only if the contact is an individual. is_organization is set to false.
Parent Organization ID	The unique identifier of a contact that should be set as parent for this organization. Setting this to null will clear existing parent relation. Referenced contact also has to be an organization. It can be set only for organization contacts (is_organization set to true).
Owner ID	The unique identifier of the user who owns the contact.
Customer Status	Customer status of the contact. Possible values: none, current, past.
Prospect Status	Prospect status of the contact. Possible values: none, current, lost.
Title	Job title of the contact.
Description	Additional notes or details about the contact.
Industry	Industry classification of the contact.
Website	Website URL of the contact.
Email	Email address of the contact.
Phone	Phone number of the contact.
Mobile	Mobile phone number of the contact.
Fax	Fax number of the contact.
Twitter	Twitter username of the contact.
Facebook	Facebook username of the contact.
LinkedIn	LinkedIn username of the contact.
Skype	Skype username of the contact.
Address	Physical address of the contact.
Billing Address	Billing address of the contact. Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details).
Shipping Address	Shipping address of the contact. Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details).
Tag	Tags to apply to the contact. You need to supply the entire set.
Custom Field	Filterable custom field key-value pairs.

Update Deal

Updates deal information.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Deal ID	The unique identifier of the deal to update.
Name	Name of the deal.
Value	Value of the deal in decimal format (e.g., two decimal places).
Currency	The currency code for the deal value. If omitted, the account default currency is used.
Owner ID	The unique identifier of the user who owns the deal.
Hot	When true, marks the deal as hot.
Stage ID	The unique identifier of the pipeline stage for this deal.
Last Stage Change At	Date and time when the deal was moved into the current stage in UTC (ISO8601 format).
Added At	Date and time that the deal was started in UTC (ISO8601 format).
Source ID	ID of the deal Source.
Loss Reason ID	ID of the Loss Reason.
Unqualified Reason ID	ID of the Unqualify Reason.
Contact ID	Unique identifier of a primary contact.
Estimated Close Date	Expected date when the deal will close.
Customized Win Likelihood	User-provided win likelihood with value range 0-100.
Tag	Tags to apply. You need to supply the entire set.
Custom Field	Filterable custom field key-value pairs.

Update Lead

Updates lead information.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Lead ID	The unique identifier of the lead to update.
Owner ID	The unique identifier of the user who owns the lead.
First Name	First name of the contact.
Last Name	The last name of the lead.
Organization Name	The name of the organization for organization-type leads.
Status	Status of the lead.
Source ID	The unique identifier of the lead source.
Unqualified Reason ID	The unique identifier of the reason the lead was unqualified.
Title	Job title or role.
Description	Description or notes.
Industry	Industry classification.
Website	Website URL.
Email	Email address.
Phone	Phone number.
Mobile	Mobile phone number.
Fax	Fax number.
Twitter	Twitter username.
Facebook	Facebook username.
LinkedIn	LinkedIn username.
Skype	Skype username.
Address	The physical address of the lead in JSON format.
Tag	Tags to apply. You need to supply the entire set.
Custom Field	Filterable custom field key-value pairs.

Update Note

Updates note information.

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

Update Order

Updates order information.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Order ID	The unique identifier of the order to update.
Discount	Overall discount on the order in percents.

Update Task

Updates task information.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Task ID	The unique identifier of the task to update.
Content	The description or body of the task.
Due Date	The date and time when the task is due. Format: ISO8601 UTC.
Owner ID	Defaults to the unique identifier of the user who created the task.
Resource Type	The type of resource the task is related to. Possible values: lead, contact, deal.
Resource ID	The unique identifier of the resource the task is related to.
Completed	When true, marks the task as completed.
Remind At	The date and time to send a reminder for this task. Format: ISO8601 UTC.

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.

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Creator ID	User ID. Returns all contacts created by that user.
Owner ID	User ID. Returns all contacts owned by that user.
Is Organization	Indicates whether or not this contact refers to an organization or an individual.
Contact ID	The unique identifier of the organization that the contact belongs to.
Parent Organization ID	The unique identifier of a contact that should be set as parent for this organization. Setting this to null will clear existing parent relation. Referenced contact also has to be an organization. It can be set only for organization contacts (is_organization set to true.
Name	Name of the contact.
First Name	First name of the contact.
Last Name	Last name of the contact.
Email	Email address of the contact.
Phone	Phone number of the contact.
Mobile	Mobile phone number of the contact.
Customer Status	Customer status of the contact. Possible values: none, current, past
Prospect Status	Prospect status of the contact. Possible values: none, current, lost
Address (City)	City name.
Address (Postal Code)	Zip code or equivalent
Address (Country)	Country name.
Billing Address	Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details).
Shipping Address	Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details).
Custom Field	Filterable custom field key-value pairs.
Filter	Filterable custom field.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.

Upsert Lead

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

Input	Comments	Default
Connection	The Zendesk Sell connection to use.
Creator ID	User ID. Returns all leads created by that user.
Owner ID	User ID. Returns all leads owned by that user.
Source ID	ID of the Source.
First Name	First name of the lead.
Last Name	Last name of the lead.
Organization Name	Organization name of the lead.
Status	Status of the lead.
Email	Email address of the lead.
Phone	Phone number of the lead.
Mobile	Mobile phone number of the lead.
Address[city]	City name.
Address[postal Code]	Zip or Postal code
Address[country]	Country name.
Custom Field	Filterable custom field key-value pairs.
Filter	Filterable custom field.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.

Documentation Index