Zendesk Sell Component

Manage leads, contacts, and deals in Zendesk Sell.

Component key: zendesk-sell · Changelog ↓

Description

Zendesk Sell is a sales force automation and CRM platform. This component allows you to manage 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

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.

{
  "result": [
    {
      "label": "Example Account",
      "key": "12345"
    }
  ]
}

Select Contact

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Contact",
      "key": "12345"
    }
  ]
}

Select Deal

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Deal",
      "key": "12345"
    }
  ]
}

Select Lead

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Lead",
      "key": "12345"
    }
  ]
}

Select Note

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Note",
      "key": "12345"
    }
  ]
}

Select Order

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Order",
      "key": "12345"
    }
  ]
}

Select Pipeline

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Pipeline",
      "key": "12345"
    }
  ]
}

Select Product

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Product",
      "key": "12345"
    }
  ]
}

Select Stage

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Stage",
      "key": "12345"
    }
  ]
}

Select Task

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "result": [
    {
      "label": "Example Task",
      "key": "12345"
    }
  ]
}

Actions

Create Contact

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

Input	Notes	Example
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).
Connection	The Zendesk Sell connection to use.
Contact ID	The field will be set only if the contact is an individual. is_organization is set to false.	87654321
Customer Status	Customer status of the contact. Possible values: none, current, past.	none
Custom Field	Filterable custom field key-value pairs.	{"known_via": "tom", "preferred_contact": "email"}
Description	Additional notes or details about the contact.	I know him via Tom
Email	Email address of the contact.	mark@designservices.com
Facebook	Facebook username of the contact.	mjohnson
Fax	Fax number of the contact.	+44-208-1234567
First Name	The field will be set only if the contact is an individual. is_organization is set to false.	John
Industry	Industry classification of the contact.	Design Services
Is Organization	This value can be set only during creation and cannot be changed later.
Last Name	Required only if the contact is an individual. is_organization is set to false.	Doe
LinkedIn	LinkedIn username of the contact.	mjohnson
Mobile	Mobile phone number of the contact.	508-778-6516
Name	Required only if the contact is an organization. is_organization is set to true.	Acme Corporation
Owner ID	Defaults to the unique identifier of the user who created the contact.	12345678
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).	11223344
Phone	Phone number of the contact.	508-778-6516
Prospect Status	Prospect status of the contact. Possible values: none, current, lost.	current
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).
Skype	Skype username of the contact.	mjohnson
Tag	Tags to apply to the contact. You need to supply the entire set.	["contractor", "vip"]
Title	Job title of the contact.	CEO
Twitter	Twitter username of the contact.	mjohnson
Website	Website URL of the contact.	www.designservices.com

{
  "data": {
    "data": {
      "id": 47912050,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "is_organization": false,
      "contact_id": 47912048,
      "parent_organization_id": null,
      "name": "Mark Johnson",
      "first_name": "Mark",
      "last_name": "Johnson",
      "customer_status": "current",
      "prospect_status": "none",
      "title": "VP of Sales",
      "description": "Key decision maker for Q4 renewals",
      "industry": "Technology",
      "website": "https://www.acmecorp.io",
      "email": "mark.johnson@acmecorp.io",
      "phone": "+1-415-555-0198",
      "mobile": "+1-415-555-0199",
      "fax": "+1-415-555-0200",
      "twitter": "markjohnson",
      "facebook": "mark.johnson.sales",
      "linkedin": "markjohnson-vpsales",
      "skype": "mark.johnson.acme",
      "address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "billing_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "shipping_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "tags": [
        "enterprise",
        "priority"
      ],
      "custom_fields": {
        "referred_by": "Partner Channel"
      },
      "created_at": "2024-08-15T09:32:17Z",
      "updated_at": "2025-01-10T14:05:42Z"
    },
    "meta": {
      "type": "contact"
    }
  }
}

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).
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 Field	Filterable custom field key-value pairs.
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).
Loss Reason ID	ID of the Loss Reason.	12345678
Name	Name of the deal.	Q1 Enterprise Deal
Owner ID	Defaults to the unique identifier of the user that the deal is created by.	12345678
Source ID	ID of the deal Source.	12345678
Stage ID	If omitted, the deal will be placed in the first stage of the default pipeline.	12345678
Tag	Tags to apply. You need to supply the entire set.
Unqualified Reason ID	ID of the Unqualify Reason.	12345678
Value	Value of the deal in decimal format (e.g., two decimal places).	5000.00

{
  "data": {
    "data": {
      "id": 8150614,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "name": "Acme Corp - Enterprise License",
      "value": 125000,
      "currency": "USD",
      "hot": true,
      "stage_id": 4817283,
      "last_stage_change_at": "2025-01-08T11:20:35Z",
      "last_stage_change_by_id": 1290481,
      "last_activity_at": "2025-01-10T16:42:18Z",
      "source_id": 2940175,
      "loss_reason_id": null,
      "unqualified_reason_id": null,
      "dropbox_email": "dropbox@67432.deals.futuresimple.com",
      "contact_id": 47912050,
      "organization_id": 47912048,
      "estimated_close_date": "2025-03-31",
      "customized_win_likelihood": 75,
      "tags": [
        "enterprise",
        "q1-target"
      ],
      "custom_fields": {
        "contract_length": "24 months"
      },
      "created_at": "2024-10-22T08:15:30Z",
      "updated_at": "2025-01-10T16:42:18Z",
      "added_at": "2024-10-22T08:15:30Z"
    },
    "meta": {
      "type": "deal"
    }
  }
}

Create Lead

Creates a new lead. | key: createLead

Input	Notes	Example
Address	The physical address of the lead in JSON format.
Connection	The Zendesk Sell connection to use.
Custom Field	Filterable custom field key-value pairs.	key: known_via value: tom
Description	Description or notes.	Key decision maker for enterprise software
Email	Email address.	john.doe@example.com
Facebook	Facebook username.	johndoe
Fax	Fax number.	+44-208-1234567
First Name	First name of the contact.	John
Industry	Industry classification.	Technology
Last Name	Required only if a lead is an individual. company_name is empty.	Doe
LinkedIn	LinkedIn username.	johndoe
Mobile	Mobile phone number.	508-778-6516
Organization Name	Required only if a lead is an organization. last_name is empty.	Acme Corporation
Owner ID	Defaults to user's unique identifier of the user who created the lead is created by.	12345678
Phone	Phone number.	508-778-6516
Skype	Skype username.	johndoe
Source ID	The unique identifier of the lead source.	12345678
Status	Status of the lead.	New
Tag	Tags to apply. You need to supply the entire set.	important
Title	Job title or role.	CEO
Twitter	Twitter username.	johndoe
Unqualified Reason ID	The unique identifier of the reason the lead was unqualified.	12345678
Website	Website URL.	www.example.com

{
  "data": {
    "data": {
      "id": 3194720,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "first_name": "Sarah",
      "last_name": "Williams",
      "organization_name": "TechStart Solutions",
      "status": "New",
      "source_id": 2940175,
      "unqualified_reason_id": null,
      "title": "Director of Operations",
      "description": "Inbound lead from webinar signup",
      "industry": "Software",
      "website": "https://www.techstartsolutions.com",
      "email": "sarah.williams@techstartsolutions.com",
      "phone": "+1-650-555-0142",
      "mobile": "+1-650-555-0143",
      "fax": null,
      "twitter": "sarahwilliams_ops",
      "facebook": null,
      "linkedin": "sarahwilliams-ops",
      "skype": null,
      "address": {
        "line1": "480 Mission St",
        "city": "San Francisco",
        "postal_code": "94105",
        "state": "CA",
        "country": "US"
      },
      "tags": [
        "webinar",
        "inbound"
      ],
      "custom_fields": {
        "lead_score": "85"
      },
      "created_at": "2025-01-05T13:22:10Z",
      "updated_at": "2025-01-09T09:45:33Z"
    },
    "meta": {
      "type": "lead"
    }
  }
}

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
Tag	Tags to apply to the note.	premium
Type	The type of note. Possible values: regular or other types supported by the API.	regular

{
  "data": {
    "data": {
      "id": 29475810,
      "creator_id": 1290481,
      "resource_type": "contact",
      "resource_id": 47912050,
      "content": "Had a productive call with Mark regarding the Q1 renewal. He confirmed budget approval and expects to sign by end of March.",
      "is_important": true,
      "tags": [
        "follow-up",
        "renewal"
      ],
      "type": "regular",
      "created_at": "2025-01-10T10:15:22Z",
      "updated_at": "2025-01-10T10:15:22Z"
    },
    "meta": {
      "type": "note"
    }
  }
}

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

{
  "data": {
    "data": {
      "id": 5612840,
      "deal_id": 8150614,
      "discount": 10,
      "created_at": "2025-01-12T08:30:45Z",
      "updated_at": "2025-01-12T08:30:45Z"
    },
    "meta": {
      "type": "order"
    }
  }
}

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

{
  "data": {
    "data": {
      "id": 16238471,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "resource_type": "deal",
      "resource_id": 8150614,
      "completed": false,
      "completed_at": null,
      "due_date": "2025-02-15T17:00:00Z",
      "overdue": false,
      "remind_at": "2025-02-15T09:00:00Z",
      "content": "Send updated pricing proposal to Acme Corp",
      "created_at": "2025-01-10T11:30:55Z",
      "updated_at": "2025-01-10T11:30:55Z"
    },
    "meta": {
      "type": "task"
    }
  }
}

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 to delete.	12345678

{
  "data": null
}

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 to delete.	12345678

{
  "data": null
}

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 to delete.	12345678

{
  "data": null
}

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	Unique identifier of the note.	12345678

{
  "data": null
}

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 to delete.	12345678

{
  "data": null
}

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 to delete.	12345678

{
  "data": null
}

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 to retrieve.	12345678

{
  "data": {
    "data": {
      "id": 47912050,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "is_organization": false,
      "contact_id": 47912048,
      "parent_organization_id": null,
      "name": "Mark Johnson",
      "first_name": "Mark",
      "last_name": "Johnson",
      "customer_status": "current",
      "prospect_status": "none",
      "title": "VP of Sales",
      "description": "Key decision maker for Q4 renewals",
      "industry": "Technology",
      "website": "https://www.acmecorp.io",
      "email": "mark.johnson@acmecorp.io",
      "phone": "+1-415-555-0198",
      "mobile": "+1-415-555-0199",
      "fax": "+1-415-555-0200",
      "twitter": "markjohnson",
      "facebook": "mark.johnson.sales",
      "linkedin": "markjohnson-vpsales",
      "skype": "mark.johnson.acme",
      "address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "billing_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "shipping_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "tags": [
        "enterprise",
        "priority"
      ],
      "custom_fields": {
        "referred_by": "Partner Channel"
      },
      "created_at": "2024-08-15T09:32:17Z",
      "updated_at": "2025-01-10T14:05:42Z"
    },
    "meta": {
      "type": "contact"
    }
  }
}

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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 47912050
        },
        "meta": {
          "type": "contact",
          "sync": {
            "event_type": "updated",
            "ack_key": "Contact-47912050-1",
            "revision": 3
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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.
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.

{
  "data": {
    "items": [
      {
        "data": {
          "id": 8471520
        },
        "meta": {
          "type": "custom_field",
          "sync": {
            "event_type": "updated",
            "ack_key": "CustomField-8471520-1",
            "revision": 1
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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 to retrieve.	12345678
Includes	Comma-separated list of one or more resources related to the deal. Possible values: associated_contacts.	associated_contacts

{
  "data": {
    "data": {
      "id": 8150614,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "name": "Acme Corp - Enterprise License",
      "value": 125000,
      "currency": "USD",
      "hot": true,
      "stage_id": 4817283,
      "last_stage_change_at": "2025-01-08T11:20:35Z",
      "last_stage_change_by_id": 1290481,
      "last_activity_at": "2025-01-10T16:42:18Z",
      "source_id": 2940175,
      "loss_reason_id": null,
      "unqualified_reason_id": null,
      "dropbox_email": "dropbox@67432.deals.futuresimple.com",
      "contact_id": 47912050,
      "organization_id": 47912048,
      "estimated_close_date": "2025-03-31",
      "customized_win_likelihood": 75,
      "tags": [
        "enterprise",
        "q1-target"
      ],
      "custom_fields": {
        "contract_length": "24 months"
      },
      "created_at": "2024-10-22T08:15:30Z",
      "updated_at": "2025-01-10T16:42:18Z",
      "added_at": "2024-10-22T08:15:30Z"
    },
    "meta": {
      "type": "deal"
    }
  }
}

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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 8150614
        },
        "meta": {
          "type": "deal",
          "sync": {
            "event_type": "updated",
            "ack_key": "Deal-8150614-1",
            "revision": 5
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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 to retrieve.	12345678

{
  "data": {
    "data": {
      "id": 3194720,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "first_name": "Sarah",
      "last_name": "Williams",
      "organization_name": "TechStart Solutions",
      "status": "New",
      "source_id": 2940175,
      "unqualified_reason_id": null,
      "title": "Director of Operations",
      "description": "Inbound lead from webinar signup",
      "industry": "Software",
      "website": "https://www.techstartsolutions.com",
      "email": "sarah.williams@techstartsolutions.com",
      "phone": "+1-650-555-0142",
      "mobile": "+1-650-555-0143",
      "fax": null,
      "twitter": "sarahwilliams_ops",
      "facebook": null,
      "linkedin": "sarahwilliams-ops",
      "skype": null,
      "address": {
        "line1": "480 Mission St",
        "city": "San Francisco",
        "postal_code": "94105",
        "state": "CA",
        "country": "US"
      },
      "tags": [
        "webinar",
        "inbound"
      ],
      "custom_fields": {
        "lead_score": "85"
      },
      "created_at": "2025-01-05T13:22:10Z",
      "updated_at": "2025-01-09T09:45:33Z"
    },
    "meta": {
      "type": "lead"
    }
  }
}

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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 3194720
        },
        "meta": {
          "type": "lead",
          "sync": {
            "event_type": "updated",
            "ack_key": "Lead-3194720-1",
            "revision": 2
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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

{
  "data": {
    "data": {
      "id": 29475810,
      "creator_id": 1290481,
      "resource_type": "contact",
      "resource_id": 47912050,
      "content": "Had a productive call with Mark regarding the Q1 renewal. He confirmed budget approval and expects to sign by end of March.",
      "is_important": true,
      "tags": [
        "follow-up",
        "renewal"
      ],
      "type": "regular",
      "created_at": "2025-01-10T10:15:22Z",
      "updated_at": "2025-01-10T10:15:22Z"
    },
    "meta": {
      "type": "note"
    }
  }
}

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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 29475810
        },
        "meta": {
          "type": "note",
          "sync": {
            "event_type": "created",
            "ack_key": "Note-29475810-1",
            "revision": 1
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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 to retrieve.	12345678

{
  "data": {
    "data": {
      "id": 5612840,
      "deal_id": 8150614,
      "discount": 10,
      "created_at": "2025-01-12T08:30:45Z",
      "updated_at": "2025-01-12T08:30:45Z"
    },
    "meta": {
      "type": "order"
    }
  }
}

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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 5612840
        },
        "meta": {
          "type": "order",
          "sync": {
            "event_type": "created",
            "ack_key": "Order-5612840-1",
            "revision": 1
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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.
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.

{
  "data": {
    "items": [
      {
        "data": {
          "id": 7391024
        },
        "meta": {
          "type": "product",
          "sync": {
            "event_type": "created",
            "ack_key": "Product-7391024-1",
            "revision": 1
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 4817283
        },
        "meta": {
          "type": "stage",
          "sync": {
            "event_type": "updated",
            "ack_key": "Stage-4817283-1",
            "revision": 2
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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.
Position	The client position in the Firehose stream. Possible values: top, tail, or a position string from a previous API response.
Resource	The resource to get the stream for.

{
  "data": {
    "items": [
      {
        "data": {
          "id": 12345678
        },
        "meta": {
          "type": "resource",
          "sync": {
            "event_type": "updated",
            "ack_key": "Resource-12345678-1",
            "revision": 1
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

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 to retrieve.	12345678

{
  "data": {
    "data": {
      "id": 16238471,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "resource_type": "deal",
      "resource_id": 8150614,
      "completed": false,
      "completed_at": null,
      "due_date": "2025-02-15T17:00:00Z",
      "overdue": false,
      "remind_at": "2025-02-15T09:00:00Z",
      "content": "Send updated pricing proposal to Acme Corp",
      "created_at": "2025-01-10T11:30:55Z",
      "updated_at": "2025-01-10T11:30:55Z"
    },
    "meta": {
      "type": "task"
    }
  }
}

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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 16238471
        },
        "meta": {
          "type": "task",
          "sync": {
            "event_type": "created",
            "ack_key": "Task-16238471-1",
            "revision": 1
          }
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {}
    }
  }
}

List Account Details

Retrieves account details. | key: listAccountDetails

Input	Notes	Example
Connection	The Zendesk Sell connection to use.

{
  "data": {
    "data": {
      "id": 1482750,
      "name": "Acme Corp Sales",
      "currency": "USD",
      "time_format": "12H",
      "timezone": "UTC-06:00",
      "phone": "+1-312-555-0100",
      "subdomain": "acme-sales",
      "created_at": "2023-01-10T08:00:00Z",
      "updated_at": "2025-01-05T12:30:00Z"
    },
    "meta": {
      "type": "account"
    }
  }
}

List Contacts

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

Input	Notes	Example
Address (City)	City name.
Address (Country)	Country name.
Address (Postal Code)	Zip code or equivalent
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).
Connection	The Zendesk Sell connection to use.
Contact ID	The unique identifier of the organization that the contact belongs to.	87654321
Creator ID	User ID. Returns all contacts created by that user.	12345678
Customer Status	Customer status of the contact. Possible values: none, current, past
Custom Field	Filterable custom field key-value pairs.	key: external_id value: SKU01
Email	Email address of the contact.
First Name	First name of the contact.
IDs	Comma-separated list of the IDs for the contacts you want to be returned in your request.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Is Organization	Indicates whether or not this contact refers to an organization or an individual.
Last Name	Last name of the contact.	Doe
Mobile	Mobile phone number of the contact.
Name	Name of the contact.
Owner ID	User ID. Returns all contacts owned by that user.	12345678
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.
Phone	Phone number of the contact.
Prospect Status	Prospect status of the contact. Possible values: none, current, lost
Shipping Address	null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details).
Sort By	A field to sort by. You can sort by filterable custom fields as well.

{
  "data": {
    "items": [
      {
        "data": {
          "id": 47912050,
          "creator_id": 1290481,
          "owner_id": 1290481,
          "is_organization": false,
          "contact_id": 47912048,
          "parent_organization_id": null,
          "name": "Mark Johnson",
          "first_name": "Mark",
          "last_name": "Johnson",
          "customer_status": "current",
          "prospect_status": "none",
          "title": "VP of Sales",
          "description": "Key decision maker for Q4 renewals",
          "industry": "Technology",
          "website": "https://www.acmecorp.io",
          "email": "mark.johnson@acmecorp.io",
          "phone": "+1-415-555-0198",
          "mobile": "+1-415-555-0199",
          "fax": "+1-415-555-0200",
          "twitter": "markjohnson",
          "facebook": "mark.johnson.sales",
          "linkedin": "markjohnson-vpsales",
          "skype": "mark.johnson.acme",
          "address": {
            "line1": "2726 Smith St",
            "city": "Hainesville",
            "postal_code": "60030",
            "state": "IL",
            "country": "US"
          },
          "billing_address": {
            "line1": "2726 Smith St",
            "city": "Hainesville",
            "postal_code": "60030",
            "state": "IL",
            "country": "US"
          },
          "shipping_address": {
            "line1": "2726 Smith St",
            "city": "Hainesville",
            "postal_code": "60030",
            "state": "IL",
            "country": "US"
          },
          "tags": [
            "enterprise",
            "priority"
          ],
          "custom_fields": {
            "referred_by": "Partner Channel"
          },
          "created_at": "2024-08-15T09:32:17Z",
          "updated_at": "2025-01-10T14:05:42Z"
        },
        "meta": {
          "type": "contact"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/contacts?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/contacts?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

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.

{
  "data": {
    "items": [
      {
        "data": {
          "id": 8471520,
          "name": "Referred By",
          "type": "string",
          "choices": null,
          "for_company": true,
          "for_contact": true,
          "created_at": "2024-03-15T09:00:00Z",
          "updated_at": "2024-03-15T09:00:00Z"
        },
        "meta": {
          "type": "custom_field"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/contact/custom_fields?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/contact/custom_fields?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

List Deals

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

Input	Notes	Example
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.
Custom Field	Filterable custom field key-value pairs.	key: external_id value: SKU01
Estimated Close Date	Estimated close date of the deal.
Hot	Indicator of whether or not the deal is hot.
IDs	Comma-separated list of deal IDs to be returned in a request.	12345678,87654321
Includes	Comma-separated list of one or more resources related to a deal.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Name	Name of the deal.
Organization ID	Unique identifier of an organization.
Owner ID	Unique identifier of the user the deal is owned by. Returns all deals owned by the user.	12345678
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.
Sort By	A field to sort by. You can sort by filterable custom fields as well.
Source ID	ID of the Source.	12345678
Stage ID	ID of the Stage.	12345678
Value	Value of the deal. We encourage you to use a string with two decimal places.

{
  "data": {
    "items": [
      {
        "data": {
          "id": 8150614,
          "creator_id": 1290481,
          "owner_id": 1290481,
          "name": "Acme Corp - Enterprise License",
          "value": 125000,
          "currency": "USD",
          "hot": true,
          "stage_id": 4817283,
          "last_stage_change_at": "2025-01-08T11:20:35Z",
          "last_stage_change_by_id": 1290481,
          "last_activity_at": "2025-01-10T16:42:18Z",
          "source_id": 2940175,
          "loss_reason_id": null,
          "unqualified_reason_id": null,
          "dropbox_email": "dropbox@67432.deals.futuresimple.com",
          "contact_id": 47912050,
          "organization_id": 47912048,
          "estimated_close_date": "2025-03-31",
          "customized_win_likelihood": 75,
          "tags": [
            "enterprise",
            "q1-target"
          ],
          "custom_fields": {
            "contract_length": "24 months"
          },
          "created_at": "2024-10-22T08:15:30Z",
          "updated_at": "2025-01-10T16:42:18Z",
          "added_at": "2024-10-22T08:15:30Z"
        },
        "meta": {
          "type": "deal"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/deals?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/deals?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

List Leads

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

Input	Notes	Example
Address[city]	City name.
Address[country]	Country name.
Address[postal Code]	Zip or Postal code.
Address[state]	State/region name.
Connection	The Zendesk Sell connection to use.
Creator ID	User ID. Returns all leads created by that user.	12345678
Custom Field	Filterable custom field key-value pairs.	key: external_id value: SKU01
Email	Email address of the lead.
First Name	First name of the lead.
IDs	Comma-separated list of lead IDs to be returned in a request.	12345678,87654321
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Last Name	Last name of the lead.	Doe
Mobile	Mobile phone number of the lead.
Organization Name	Organization name of the lead.	Acme Corporation
Owner ID	User ID. Returns all leads owned by that user.	12345678
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.
Phone	Phone number of the lead.
Sort By	A field to sort by. You can sort by filterable custom fields as well.
Source ID	ID of the Source.	12345678
Status	Status of the lead.

{
  "data": {
    "items": [
      {
        "data": {
          "id": 3194720,
          "creator_id": 1290481,
          "owner_id": 1290481,
          "first_name": "Sarah",
          "last_name": "Williams",
          "organization_name": "TechStart Solutions",
          "status": "New",
          "source_id": 2940175,
          "unqualified_reason_id": null,
          "title": "Director of Operations",
          "description": "Inbound lead from webinar signup",
          "industry": "Software",
          "website": "https://www.techstartsolutions.com",
          "email": "sarah.williams@techstartsolutions.com",
          "phone": "+1-650-555-0142",
          "mobile": "+1-650-555-0143",
          "fax": null,
          "twitter": "sarahwilliams_ops",
          "facebook": null,
          "linkedin": "sarahwilliams-ops",
          "skype": null,
          "address": {
            "line1": "480 Mission St",
            "city": "San Francisco",
            "postal_code": "94105",
            "state": "CA",
            "country": "US"
          },
          "tags": [
            "webinar",
            "inbound"
          ],
          "custom_fields": {
            "lead_score": "85"
          },
          "created_at": "2025-01-05T13:22:10Z",
          "updated_at": "2025-01-09T09:45:33Z"
        },
        "meta": {
          "type": "lead"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/leads?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/leads?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

List Notes

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Creator ID	Unique identifier of the user. Returns all notes created by the user.
IDs	Comma-separated list of note IDs to be returned in a request.	12345678,87654321
Includes	Comma-separated list of one or more resources related to the note. Not supported at the moment.
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.
Q	A query string to search for. Performs a full text search on the content field.
Resource ID	Unique identifier of the resource to search for.
Resource Type	Name of the type of resource to search for. Possible values: lead, contact, deal
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

{
  "data": {
    "items": [
      {
        "data": {
          "id": 29475810,
          "creator_id": 1290481,
          "resource_type": "contact",
          "resource_id": 47912050,
          "content": "Had a productive call with Mark regarding the Q1 renewal. He confirmed budget approval and expects to sign by end of March.",
          "is_important": true,
          "tags": [
            "follow-up",
            "renewal"
          ],
          "type": "regular",
          "created_at": "2025-01-10T10:15:22Z",
          "updated_at": "2025-01-10T10:15:22Z"
        },
        "meta": {
          "type": "note"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/notes?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/notes?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

List Orders

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

Input	Notes	Example
Connection	The Zendesk Sell connection to use.
Deal ID	ID of the deal order is associated to.	12
IDs	Comma-separated list of IDs to be returned in request.	1,2,3
Page	Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.	2
Per Page	Number of records to return per page. Defaults to 25. Maximum is 500.
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.	value:desc

{
  "data": {
    "items": [
      {
        "data": {
          "id": 5612840,
          "deal_id": 8150614,
          "discount": 10,
          "created_at": "2025-01-12T08:30:45Z",
          "updated_at": "2025-01-12T08:30:45Z"
        },
        "meta": {
          "type": "order"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/orders?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/orders?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

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
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
Page	Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.	2
Per Page	Number of records to return per page. Default limit is 25 and the maximum number that can be returned is 100.	20
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:desc

{
  "data": {
    "items": [
      {
        "data": {
          "id": 1074820,
          "name": "Sales Pipeline",
          "created_at": "2023-06-15T10:00:00Z",
          "updated_at": "2024-11-20T14:35:12Z",
          "disabled": false
        },
        "meta": {
          "type": "pipeline"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/pipelines?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/pipelines?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

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.
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.
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.
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	position:desc

{
  "data": {
    "items": [
      {
        "data": {
          "id": 4817283,
          "name": "Qualified",
          "category": "Qualified",
          "active": true,
          "position": 2,
          "likelihood": 30,
          "pipeline_id": 1074820,
          "created_at": "2023-06-15T10:00:00Z",
          "updated_at": "2024-11-20T14:35:12Z"
        },
        "meta": {
          "type": "stage"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/stages?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/stages?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

List Tasks

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

Input	Notes	Example
Completed	Indicates whether the query will return tasks that are completed or not.
Connection	The Zendesk Sell connection to use.
Creator ID	Unique identifier of the user. Returns all tasks created by the user.
IDs	Comma-separated list of task IDs to be returned in a request.	12345678,87654321
Overdue	Indicates whether the query will return tasks where the due_date parameter has been passed or not.
Owner ID	Unique identifier of the user. Returns all tasks owned by the user.	12345678
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.
Q	A query string to search for. Performs a full text search on the content field.
Remind	Indicates whether the query will return tasks with reminders or without reminders.
Resource ID	Unique identifier of the resource that you're searching for.
Resource Type	Name of the resource type to search for. Possible values: lead, contact, deal
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	resource_type:desc
Type	Type of tasks to search for. Possible values: floating, related

{
  "data": {
    "items": [
      {
        "data": {
          "id": 16238471,
          "creator_id": 1290481,
          "owner_id": 1290481,
          "resource_type": "deal",
          "resource_id": 8150614,
          "completed": false,
          "completed_at": null,
          "due_date": "2025-02-15T17:00:00Z",
          "overdue": false,
          "remind_at": "2025-02-15T09:00:00Z",
          "content": "Send updated pricing proposal to Acme Corp",
          "created_at": "2025-01-10T11:30:55Z",
          "updated_at": "2025-01-10T11:30:55Z"
        },
        "meta": {
          "type": "task"
        }
      }
    ],
    "meta": {
      "type": "collection",
      "count": 1,
      "links": {
        "self": "https://api.getbase.com/v2/tasks?page=1&per_page=25",
        "first_page": "https://api.getbase.com/v2/tasks?page=1&per_page=25",
        "next_page": null
      }
    }
  }
}

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

{
  "data": {
    "data": {},
    "meta": {
      "type": "unknown"
    }
  }
}

Update Contact

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

Input	Notes	Example
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).
Connection	The Zendesk Sell connection to use.
Contact ID	The field will be set only if the contact is an individual. is_organization is set to false.	87654321
Customer Status	Customer status of the contact. Possible values: none, current, past.
Custom Field	Filterable custom field key-value pairs.	{"known_via": "tom", "preferred_contact": "email"}
Description	Additional notes or details about the contact.	I know him via Tom
Email	Email address of the contact.	mark@designservices.com
Facebook	Facebook username of the contact.	mjohnson
Fax	Fax number of the contact.	+44-208-1234567
First Name	The field will be set only if the contact is an individual. is_organization is set to false.	John
ID	The unique identifier of the contact.	12345678
Industry	Industry classification of the contact.	Design Services
Last Name	The field will be set only if the contact is an individual. is_organization is set to false.	Doe
LinkedIn	LinkedIn username of the contact.	mjohnson
Mobile	Mobile phone number of the contact.	508-778-6516
Name	This field will be set only if the contact is an organization. is_organization is set to true.	Acme Corporation
Owner ID	The unique identifier of the user who owns the contact.	12345678
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).	11223344
Phone	Phone number of the contact.	508-778-6516
Prospect Status	Prospect status of the contact. Possible values: none, current, lost.	current
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).
Skype	Skype username of the contact.	mjohnson
Tag	Tags to apply to the contact. You need to supply the entire set.	["contractor", "vip"]
Title	Job title of the contact.	CEO
Twitter	Twitter username of the contact.	mjohnson
Website	Website URL of the contact.	www.designservices.com

{
  "data": {
    "data": {
      "id": 47912050,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "is_organization": false,
      "contact_id": 47912048,
      "parent_organization_id": null,
      "name": "Mark Johnson",
      "first_name": "Mark",
      "last_name": "Johnson",
      "customer_status": "current",
      "prospect_status": "none",
      "title": "VP of Sales",
      "description": "Key decision maker for Q4 renewals",
      "industry": "Technology",
      "website": "https://www.acmecorp.io",
      "email": "mark.johnson@acmecorp.io",
      "phone": "+1-415-555-0198",
      "mobile": "+1-415-555-0199",
      "fax": "+1-415-555-0200",
      "twitter": "markjohnson",
      "facebook": "mark.johnson.sales",
      "linkedin": "markjohnson-vpsales",
      "skype": "mark.johnson.acme",
      "address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "billing_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "shipping_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "tags": [
        "enterprise",
        "priority"
      ],
      "custom_fields": {
        "referred_by": "Partner Channel"
      },
      "created_at": "2024-08-15T09:32:17Z",
      "updated_at": "2025-01-10T14:05:42Z"
    },
    "meta": {
      "type": "contact"
    }
  }
}

Update Deal

Updates deal information. | key: updateDeal

Input	Notes	Example
Added At	Date and time that the deal was started in UTC (ISO8601 format).
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 Field	Filterable custom field key-value pairs.
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	When true, marks the deal as hot.
Deal ID	The unique identifier of the deal to update.	12345678
Last Stage Change At	Date and time when the deal was moved into the current stage in UTC (ISO8601 format).
Loss Reason ID	ID of the Loss Reason.	12345678
Name	Name of the deal.	Q1 Enterprise Deal
Owner ID	The unique identifier of the user who owns the deal.	12345678
Source ID	ID of the deal Source.	12345678
Stage ID	The unique identifier of the pipeline stage for this deal.	12345678
Tag	Tags to apply. You need to supply the entire set.
Unqualified Reason ID	ID of the Unqualify Reason.	12345678
Value	Value of the deal in decimal format (e.g., two decimal places).	5000.00

{
  "data": {
    "data": {
      "id": 8150614,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "name": "Acme Corp - Enterprise License",
      "value": 125000,
      "currency": "USD",
      "hot": true,
      "stage_id": 4817283,
      "last_stage_change_at": "2025-01-08T11:20:35Z",
      "last_stage_change_by_id": 1290481,
      "last_activity_at": "2025-01-10T16:42:18Z",
      "source_id": 2940175,
      "loss_reason_id": null,
      "unqualified_reason_id": null,
      "dropbox_email": "dropbox@67432.deals.futuresimple.com",
      "contact_id": 47912050,
      "organization_id": 47912048,
      "estimated_close_date": "2025-03-31",
      "customized_win_likelihood": 75,
      "tags": [
        "enterprise",
        "q1-target"
      ],
      "custom_fields": {
        "contract_length": "24 months"
      },
      "created_at": "2024-10-22T08:15:30Z",
      "updated_at": "2025-01-10T16:42:18Z",
      "added_at": "2024-10-22T08:15:30Z"
    },
    "meta": {
      "type": "deal"
    }
  }
}

Update Lead

Updates lead information. | key: updateLead

Input	Notes	Example
Address	The physical address of the lead in JSON format.
Connection	The Zendesk Sell connection to use.
Custom Field	Filterable custom field key-value pairs.	key: known_via value: tom
Description	Description or notes.	Key decision maker for enterprise software
Email	Email address.	john.doe@example.com
Facebook	Facebook username.	johndoe
Fax	Fax number.	+44-208-1234567
First Name	First name of the contact.	John
Lead ID	The unique identifier of the lead to update.	12345678
Industry	Industry classification.	Technology
Last Name	The last name of the lead.	Doe
LinkedIn	LinkedIn username.	johndoe
Mobile	Mobile phone number.	508-778-6516
Organization Name	The name of the organization for organization-type leads.	Acme Corporation
Owner ID	The unique identifier of the user who owns the lead.	12345678
Phone	Phone number.	508-778-6516
Skype	Skype username.	johndoe
Source ID	The unique identifier of the lead source.	12345678
Status	Status of the lead.	New
Tag	Tags to apply. You need to supply the entire set.	important
Title	Job title or role.	CEO
Twitter	Twitter username.	johndoe
Unqualified Reason ID	The unique identifier of the reason the lead was unqualified.	12345678
Website	Website URL.	www.example.com

{
  "data": {
    "data": {
      "id": 3194720,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "first_name": "Sarah",
      "last_name": "Williams",
      "organization_name": "TechStart Solutions",
      "status": "New",
      "source_id": 2940175,
      "unqualified_reason_id": null,
      "title": "Director of Operations",
      "description": "Inbound lead from webinar signup",
      "industry": "Software",
      "website": "https://www.techstartsolutions.com",
      "email": "sarah.williams@techstartsolutions.com",
      "phone": "+1-650-555-0142",
      "mobile": "+1-650-555-0143",
      "fax": null,
      "twitter": "sarahwilliams_ops",
      "facebook": null,
      "linkedin": "sarahwilliams-ops",
      "skype": null,
      "address": {
        "line1": "480 Mission St",
        "city": "San Francisco",
        "postal_code": "94105",
        "state": "CA",
        "country": "US"
      },
      "tags": [
        "webinar",
        "inbound"
      ],
      "custom_fields": {
        "lead_score": "85"
      },
      "created_at": "2025-01-05T13:22:10Z",
      "updated_at": "2025-01-09T09:45:33Z"
    },
    "meta": {
      "type": "lead"
    }
  }
}

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
Tag	Tags to apply to the note.	premium
Type	The type of note. Possible values: regular or other types supported by the API.	regular

{
  "data": {
    "data": {
      "id": 29475810,
      "creator_id": 1290481,
      "resource_type": "contact",
      "resource_id": 47912050,
      "content": "Had a productive call with Mark regarding the Q1 renewal. He confirmed budget approval and expects to sign by end of March.",
      "is_important": true,
      "tags": [
        "follow-up",
        "renewal"
      ],
      "type": "regular",
      "created_at": "2025-01-10T10:15:22Z",
      "updated_at": "2025-01-10T10:15:22Z"
    },
    "meta": {
      "type": "note"
    }
  }
}

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 to update.	12345678

{
  "data": {
    "data": {
      "id": 5612840,
      "deal_id": 8150614,
      "discount": 10,
      "created_at": "2025-01-12T08:30:45Z",
      "updated_at": "2025-01-12T08:30:45Z"
    },
    "meta": {
      "type": "order"
    }
  }
}

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 to update.	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

{
  "data": {
    "data": {
      "id": 16238471,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "resource_type": "deal",
      "resource_id": 8150614,
      "completed": false,
      "completed_at": null,
      "due_date": "2025-02-15T17:00:00Z",
      "overdue": false,
      "remind_at": "2025-02-15T09:00:00Z",
      "content": "Send updated pricing proposal to Acme Corp",
      "created_at": "2025-01-10T11:30:55Z",
      "updated_at": "2025-01-10T11:30:55Z"
    },
    "meta": {
      "type": "task"
    }
  }
}

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
Address (City)	City name.
Address (Country)	Country name.
Address (Postal Code)	Zip code or equivalent
Billing Address	Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details).
Connection	The Zendesk Sell connection to use.
Contact ID	The unique identifier of the organization that the contact belongs to.	87654321
Creator ID	User ID. Returns all contacts created by that user.	12345678
Customer Status	Customer status of the contact. Possible values: none, current, past
Custom Field	Filterable custom field key-value pairs.	key: external_id value: SKU01
Email	Email address of the contact.
Filter	Filterable custom field.	key: custom_fields[referral_website] value: https://www.test.com
First Name	First name of the contact.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Is Organization	Indicates whether or not this contact refers to an organization or an individual.
Last Name	Last name of the contact.	Doe
Mobile	Mobile phone number of the contact.
Name	Name of the contact.
Owner ID	User ID. Returns all contacts owned by that user.	12345678
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.
Phone	Phone number of the contact.
Prospect Status	Prospect status of the contact. Possible values: none, current, lost
Shipping Address	Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details).

{
  "data": {
    "data": {
      "id": 47912050,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "is_organization": false,
      "contact_id": 47912048,
      "parent_organization_id": null,
      "name": "Mark Johnson",
      "first_name": "Mark",
      "last_name": "Johnson",
      "customer_status": "current",
      "prospect_status": "none",
      "title": "VP of Sales",
      "description": "Key decision maker for Q4 renewals",
      "industry": "Technology",
      "website": "https://www.acmecorp.io",
      "email": "mark.johnson@acmecorp.io",
      "phone": "+1-415-555-0198",
      "mobile": "+1-415-555-0199",
      "fax": "+1-415-555-0200",
      "twitter": "markjohnson",
      "facebook": "mark.johnson.sales",
      "linkedin": "markjohnson-vpsales",
      "skype": "mark.johnson.acme",
      "address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "billing_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "shipping_address": {
        "line1": "2726 Smith St",
        "city": "Hainesville",
        "postal_code": "60030",
        "state": "IL",
        "country": "US"
      },
      "tags": [
        "enterprise",
        "priority"
      ],
      "custom_fields": {
        "referred_by": "Partner Channel"
      },
      "created_at": "2024-08-15T09:32:17Z",
      "updated_at": "2025-01-10T14:05:42Z"
    },
    "meta": {
      "type": "contact"
    }
  }
}

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
Address[city]	City name.
Address[country]	Country name.
Address[postal Code]	Zip or Postal code
Connection	The Zendesk Sell connection to use.
Creator ID	User ID. Returns all leads created by that user.	12345678
Custom Field	Filterable custom field key-value pairs.	key: external_id value: SKU01
Email	Email address of the lead.
Filter	Filterable custom field.	key: custom_fields[referral_website] value: https://www.test.com
First Name	First name of the lead.
Inclusive	Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters.
Last Name	Last name of the lead.	Doe
Mobile	Mobile phone number of the lead.
Organization Name	Organization name of the lead.	Acme Corporation
Owner ID	User ID. Returns all leads owned by that user.	12345678
Phone	Phone number of the lead.
Source ID	ID of the Source.	12345678
Status	Status of the lead.

{
  "data": {
    "data": {
      "id": 3194720,
      "creator_id": 1290481,
      "owner_id": 1290481,
      "first_name": "Sarah",
      "last_name": "Williams",
      "organization_name": "TechStart Solutions",
      "status": "New",
      "source_id": 2940175,
      "unqualified_reason_id": null,
      "title": "Director of Operations",
      "description": "Inbound lead from webinar signup",
      "industry": "Software",
      "website": "https://www.techstartsolutions.com",
      "email": "sarah.williams@techstartsolutions.com",
      "phone": "+1-650-555-0142",
      "mobile": "+1-650-555-0143",
      "fax": null,
      "twitter": "sarahwilliams_ops",
      "facebook": null,
      "linkedin": "sarahwilliams-ops",
      "skype": null,
      "address": {
        "line1": "480 Mission St",
        "city": "San Francisco",
        "postal_code": "94105",
        "state": "CA",
        "country": "US"
      },
      "tags": [
        "webinar",
        "inbound"
      ],
      "custom_fields": {
        "lead_score": "85"
      },
      "created_at": "2025-01-05T13:22:10Z",
      "updated_at": "2025-01-09T09:45:33Z"
    },
    "meta": {
      "type": "lead"
    }
  }
}

Changelog

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

Manage leads, contacts, and deals in Zendesk Sell.

Description​

API Documentation​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

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-04-07​

2026-03-31​

2026-03-05​