Zendesk Sell Component
Zendesk Sell is a sales force automation program.
Component key: zendesk-sell
Description
Zendesk Sell is a sales force automation program.
Connections
Zendesk Sell Oauth 2.0 Connection
The Zendesk Sell component ensures secure request authentication using OAuth 2.0. To seamlessly configure an application within Zendesk Sell, simply adhere to the instructions outlined in this comprehensive guide.
- Access Your Zendesk Sell Dashboard: To begin, log in to your Zendesk Sell Dashboard. You can reach it via a URL similar to this:
https://{YOUR SUBDOMAIN HERE}.zendesk.com/sales/dashboards/main. - Navigate to Settings: On the left-hand side toolbar, locate and click on the "Settings" option.
- Explore Integrations > OAuth: Within the Settings section, delve into the "Integrations" category and then proceed to "OAuth."
- Access OAuth2 Settings: Under the OAuth section, find the "OAuth2 Settings" and access it.
- Developer App Setup: Within the OAuth2 Settings, locate the "Developer apps" section.
- Add a Developer App: To initiate the setup process, click on the "Add Developer App" button.
- Provide App Details: Complete the required fields for the app setup. Be sure to specify the Redirect URL as
https://oauth2.prismatic.io/callback. - Retrieve Client ID and Secret: Upon successful app addition, you can obtain the Client ID and Secret by selecting the "details" button associated with your app.
Now that you've acquired the necessary credentials, the next step involves establishing a new Zendesk Sell connection within Prismatic, utilizing the obtained credentials. This integration will seamlessly link your systems, facilitating efficient data exchange and management.
| Input | Default | Notes | Example |
|---|---|---|---|
Authorize URL string / Required authorizeUrl | https://api.getbase.com/oauth2/authorize | https://api.getbase.com/oauth2/authorize | |
Client ID string / Required clientId | |||
Client Secret password / Required clientSecret | |||
Scopes string scopes | read write profile | read write profile | |
Token URL string / Required tokenUrl | https://api.getbase.com/oauth2/token | https://api.getbase.com/oauth2/token |
Data Sources
Select Account
Select Account | key: account | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Select Pipelines
Select Pipelines | key: pipelines | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Select Products
Select Products | key: products | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Select Stages
Select Stages | key: stages | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Actions
Create Contact
Create a new contact. A contact may represent a single individual or an organization. | key: createContact
| Input | Notes | Example |
|---|---|---|
Address code address | ||
Billing Address code billingAddress | null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details). | |
Connection connection / Required connection | ||
Contact Id string contactId | The field will be set only if the contact is an individual. is_organization is set to false. | |
Customer Status string customerStatus | none | |
Custom Field string Key Value List customFields | Filterable custom field. | key: known_via value: tom |
Description string description | I know him via Tom | |
Email string email | mark@designservices.com | |
Facebook string facebook | mjohnson | |
Fax string fax | +44-208-1234567 | |
First Name string firstName | The field will be set only if the contact is an individual. is_organization is set to false. | |
Industry string industry | Design Services | |
Is Organization string isOrganization | This value can be set only during creation and cannot be changed later. | |
Last Name string / Required lastName | Required only if the contact is an individual. is_organization is set to false. | |
Linkedin string linkedin | mjohnson | |
Mobile string mobile | 508-778-6516 | |
Name string / Required name | Required only if the contact is an organization. is_organization is set to true. | |
Owner Id string ownerId | Defaults to the unique identifier of the user who created the contact. | |
Parent Organization Id string parentOrganizationId | 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. | |
Phone string phone | 508-778-6516 | |
Prospect Status string prospectStatus | current | |
Shipping Address code shippingAddress | null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details). | |
Skype string skype | mjohnson | |
Tag string Value List tags | In order to modify this, you need to supply the entire set. | contractor |
Title string title | CEO | |
Twitter string twitter | mjohnson | |
Website string website | www.designservices.com |
Create Deal
Create a new deal. | key: createDeal
| Input | Notes |
|---|---|
Added At string addedAt | Date and time that the deal was started in UTC (ISO8601 format). |
Connection connection / Required connection | |
Contact Id string / Required contactId | |
Currency string currency | If omitted, currency will be set to the default currency of the account. |
Custom Field string Key Value List customFields | |
Customized Win Likelihood string customizedWinLikelihood | User-provided win likelihood with value range 0-100. |
Estimated Close Date string estimatedCloseDate | |
Hot string hot | Indicator of whether or not the deal is hot. |
Last Stage Change At string lastStageChangeAt | Date and time when the deal was moved into the current stage in UTC (ISO8601 format). |
Loss Reason Id string lossReasonId | Id of the Loss Reason. |
Name string / Required name | |
Owner Id string ownerId | Defaults to the unique identifier of the user that the deal is created by. |
Source Id string sourceId | Id of the deal Source. |
Stage Id string stageId | If omitted, the deal will be placed in the first stage of the default pipeline. |
Tag string Value List tags | |
Unqualified Reason Id string unqualifiedReasonId | Id of the Unqualify Reason. |
Value string value | Value of the deal. We encourage you to use a string with two decimal places. |
Create Lead
Creates a new lead. | key: createLead
| Input | Notes | Example |
|---|---|---|
Address code address | ||
Connection connection / Required connection | ||
Custom Field string Key Value List customFields | key: known_via value: tom | |
Description string description | ||
Email string email | ||
Facebook string facebook | ||
Fax string fax | ||
First Name string firstName | ||
Industry string industry | ||
Last Name string lastName | Required only if a lead is an individual. company_name is empty. | |
Linkedin string linkedin | ||
Mobile string mobile | ||
Organization Name string organizationName | Required only if a lead is an organization. last_name is empty. | |
Owner Id string ownerId | Defaults to user's unique identifier the lead is created by. | |
Phone string phone | ||
Skype string skype | ||
Source Id string sourceId | ||
Status string status | ||
Tag string Value List tags | important | |
Title string title | ||
Twitter string twitter | ||
Unqualified Reason Id string unqualifiedReasonId | ||
Website string website |
Create Note
Create a new note and associate it with one resource. | key: createNote
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Content string / Required content | Highly important. | |
Is Important string isImportant | ||
Resource Id string / Required resourceId | ||
Resource Type string / Required resourceType | lead | |
Tag string Value List tags | premium | |
Type string type | regular |
Create Order
Create a new order. | key: createOrder
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Deal Id string / Required dealId | The unique identifier of the deal. | |
Discount string discount | Overall discount on the order in percents. Defaults to 0. | 50 |
Create Task
Creates a new task. | key: createTask
| Input | Notes | Example |
|---|---|---|
Completed string completed | ||
Connection connection / Required connection | ||
Content string / Required content | Contact Tom | |
Due Date string dueDate | 2014-09-27T16:32:56Z | |
Owner Id string ownerId | Defaults to the unique identifier of the user who created the task. | |
Remind At string remindAt | 2014-09-29T15:32:56Z | |
Resource Id string resourceId | 1 | |
Resource Type string resourceType | lead |
Delete Contact
Delete an existing contact. This operation cannot be undone. | key: deleteContact
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Contact ID string / Required id | The unique identifier of the contact. |
Delete Deal
Delete an existing deal and remove all of the associated contacts from the deal in a single call. | key: deleteDeal
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal to delete. |
Delete Lead
Delete an existing lead. | key: deleteLead
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Lead ID string / Required id | The ID of the lead to delete. |
Delete Note
Delete an existing note. This operation cannot be undone. | key: deleteNote
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Note Id string / Required id | Unique identifier of the note. |
Delete Order
Delete an existing order and remove all of the associated line items in a single call. This operation cannot be undone. | key: deleteOrder
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Id string / Required id | The unique identifier of the order. |
Delete Task
Delete an existing task. This operation cannot be undone. | key: deleteTask
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Task ID string / Required id | The unique ID of the task. |
Get Contact
Returns a single contact available to the user, according to the unique contact ID provided. | key: getContact
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Contact ID string / Required id | The unique identifier of the contact. |
Get Contacts Stream
Read the stream of contact events. | key: getContactsStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Custom Fields Stream
Read the stream of custom fields events. | key: getCustomFieldsStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Deal
Returns a single deal available to the user. | key: getDeal
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal to retrieve. |
Includes string includes | Comma-separated list of one or more resources related to the deal. Possible values: associated_contacts |
Get Deals Stream
Read the stream of deal events. | key: getDealsStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Lead
Returns a single lead available to the user. | key: getLead
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Lead ID string / Required id | The ID of the lead to retrieve. |
Get Leads Stream
Read the stream of lead events. | key: getLeadsStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Note
Returns a single note available to the user, according to the unique note ID provided. | key: getNote
| Input | Notes |
|---|---|
Connection connection / Required connection | |
ID string / Required id | Unique identifier of the note. |
Get Notes Stream
Read the stream of note events. | key: getNotesStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Order
Returns a single order available to the user. | key: getOrder
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Id string / Required id | The unique identifier of the order. |
Get Orders Stream
Read the stream of order events. | key: getOrdersStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Products Stream
Read the stream of product events | key: getProductsStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Stages Stream
Read the stream of stage events. | key: getStagesStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Get Stream
Provides a stream of changes to Sell data. | key: getStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
Resource string / Required resource | The resource to get the stream for. |
Get Task
Returns a single task available to the user according to the unique task ID provided. | key: getTask
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Task ID string / Required id | The unique ID of the task. |
Get Tasks Stream
Read the stream of task events. | key: getTasksStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Limits maximum number of events in single response. |
Position string / Required position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail |
List Account Details
Retrieve account details | key: listAccountDetails
| Input | Notes |
|---|---|
Connection connection / Required connection |
List Contacts
Returns all contacts available to the user according to the parameters provided. | key: listContacts
| Input | Notes | Example |
|---|---|---|
Address (City) string addressCity | City name. | |
Address (Country) string addressCountry | Country name. | |
Address (Postal Code) string addressPostalCode | Zip code or equivalent | |
Address (State) string addressState | State/region name. | |
Billing Address string billingAddress | null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details). | |
Connection connection / Required connection | ||
Contact Id string contactId | The unique identifier of the organization that the contact belongs to. | |
Creator Id string creatorId | User ID. Returns all contacts created by that user. | |
Customer Status string customerStatus | Customer status of the contact. Possible values: none, current, past | |
Custom Field string Key Value List customFields | Filterable custom field. | key: external_id value: SKU01 |
Email string email | Email address of the contact. | |
First Name string firstName | First name of the contact. | |
Ids string ids | Comma-separated list of the IDs for the contacts you want to be returned in your request. | |
Inclusive string inclusive | Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters. | |
Is Organization string isOrganization | Indicates whether or not this contact refers to an organization or an individual. | |
Last Name string lastName | Last name of the contact. | |
Mobile string mobile | Mobile phone number of the contact. | |
Name string name | Name of the contact. | |
Owner Id string ownerId | User ID. Returns all contacts owned by that user. | |
Page string page | The page number to start from. Page numbering is 1-based and omitting the page parameter will return the first page. | |
Per Page string perPage | The number of records to return per page. Default limit is 25 and maximum number that can be returned is 100. | |
Phone string phone | Phone number of the contact. | |
Prospect Status string prospectStatus | Prospect status of the contact. Possible values: none, current, lost | |
Shipping Address string shippingAddress | null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details). | |
Sort By string sortBy | A field to sort by. You can sort by filterable custom fields as well. |
List Custom Fields
Returns all custom fields associated with the specified resource type. | key: listCustomFields
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Resource Type string / Required resourceType | Specifies the type for which custom fields should be returned. |
List Deals
Returns all deals available to the user. | key: listDeals
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Contact Id string contactId | Unique identifier of a primary contact. | |
Creator Id string creatorId | Unique identifier of the user the deal was created by. Returns all deals created by the user. | |
Custom Field string Key Value List customFields | Filterable custom field. | key: external_id value: SKU01 |
Estimated Close Date string estimatedCloseDate | Estimated close date of the deal. | |
Hot string hot | Indicator of whether or not the deal is hot. | |
Ids string ids | Comma-separated list of deal IDs to be returned in a request. | |
Includes string includes | Comma-separated list of one or more resources related to a deal. | |
Inclusive string inclusive | Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters. | |
Name string name | Name of the deal. | |
Organization Id string organizationId | Unique identifier of an organization. | |
Owner Id string ownerId | Unique identifier of the user the deal is owned by. Returns all deals owned by the user. | |
Page string page | Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page. | |
Per Page string perPage | Number of records to return per page. Default limit is _25_ and the maximum number that can be returned is _100_. | |
Sort By string sortBy | A field to sort by. You can sort by filterable custom fields as well. | |
Source Id string sourceId | Id of the Source. | |
Stage Id string stageId | Id of the Stage. | |
Value string value | Value of the deal. We encourage you to use a string with two decimal places. |
List Leads
Returns all leads available to the user. | key: listLeads
| Input | Notes | Example |
|---|---|---|
Address[city] string addressCity | City name. | |
Address[country] string addressCountry | Country name. | |
Address[postal Code] string addressPostalCode | Zip or Postal code. | |
Address[state] string addressState | State/region name. | |
Connection connection / Required connection | ||
Creator Id string creatorId | User ID. Returns all leads created by that user. | |
Custom Field string Key Value List customFields | Filterable custom field. | key: external_id value: SKU01 |
Email string email | Email address of the lead. | |
First Name string firstName | First name of the lead. | |
Ids string ids | Comma-separated list of lead IDs to be returned in a request. | |
Inclusive string inclusive | Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters. | |
Last Name string lastName | Last name of the lead. | |
Mobile string mobile | Mobile phone number of the lead. | |
Organization Name string organizationName | Organization name of the lead. | |
Owner Id string ownerId | User ID. Returns all leads owned by that user. | |
Page string page | Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page. | |
Per Page string perPage | Number of records to return per page. The default limit is 25 and the maximum number that can be returned is 100. | |
Phone string phone | Phone number of the lead. | |
Sort By string sortBy | A field to sort by. You can sort by filterable custom fields as well. | |
Source Id string sourceId | Id of the Source. | |
Status string status | Status of the lead. |
List Notes
Returns all notes available to the user, according to the parameters provided. | key: listNotes
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Creator Id string creatorId | Unique identifier of the user. Returns all notes created by the user. |
Ids string ids | Comma-separated list of note IDs to be returned in a request. |
Includes string includes | Comma-separated list of one or more resources related to the note. Not supported at the moment. |
Page string page | Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page. |
Per Page string perPage | 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 string q | A query string to search for. Performs a full text search on the content field. |
Resource Id string resourceId | Unique identifier of the resource to search for. |
Resource Type string resourceType | Name of the type of resource to search for. Possible values: lead, contact, deal |
Sort By string sortBy | 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 |
List Orders
Returns all orders available to the user. | key: listOrder
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Deal Id string dealId | Id of the deal order is associated to. | 12 |
Ids string ids | Comma-separated list of IDs to be returned in request. | 1,2,3 |
Page string page | Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page. | 2 |
Per Page string perPage | Number of records to return per page. Defaults to 25. Maximum is 500. | |
Sort By string sortBy | 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 |
List Pipelines
Returns all pipelines available to the user, according to the parameters provided. | key: listPipelines
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Disabled string disabled | Parameter that determines whether to return disabled or enabled pipelines. | false |
Ids string ids | Comma-separated list of IDs to be returned in request. | 1,2,3 |
Name string name | Name of the pipeline to search for. This parameter is used in a strict sense. | My Pipeline |
Page string page | Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page. | 2 |
Per Page string perPage | Number of records to return per page. Default limit is 25 and the maximum number that can be returned is 100. | 20 |
Sort By string sortBy | 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 |
List Stages
Returns all stages available to the user. | key: listStages
| Input | Notes | Example |
|---|---|---|
Active string active | Parameter that determines whether to return active or inactive stages. | |
Connection connection / Required connection | ||
Ids string ids | Comma-separated list of stage IDs to be returned in a request. | |
Name string name | Name of the stage you're searching for. This parameter is used in a strict sense. | |
Page string page | The page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page. | |
Per Page string perPage | 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 string pipelineId | The unique identifier of the pipeline that contains this stage. | |
Sort By string sortBy | 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 |
List Tasks
Returns all tasks available to the user. | key: listTasks
| Input | Notes | Example |
|---|---|---|
Completed string completed | Indicates whether the query will return tasks that are completed or not. | |
Connection connection / Required connection | ||
Creator Id string creatorId | Unique identifier of the user. Returns all tasks created by the user. | |
Ids string ids | Comma-separated list of task IDs to be returned in a request. | |
Overdue string overdue | Indicates whether the query will return tasks where the due_date parameter has been passed or not. | |
Owner Id string ownerId | Unique identifier of the user. Returns all tasks owned by the user. | |
Page string page | Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page. | |
Per Page string perPage | Number of records to return per page. The default limit is 25 and the maximum number that can be returned is 100. | |
Q string q | A query string to search for. Performs a full text search on the content field. | |
Remind string remind | Indicates whether the query will return tasks with reminders or without reminders. | |
Resource Id string resourceId | Unique identifier of the resource that you're searching for. | |
Resource Type string resourceType | Name of the resource type to search for. Possible values: lead, contact, deal | |
Sort By string sortBy | 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 string type | Type of tasks to search for. Possible values: floating, related |
Raw Request
Send raw HTTP request To Zendesk Sell | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | 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 string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | This is the URL to call. | /tasks | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. | |
Api Version string / Required version | v2 | The version of the API to use. |
Update Contact
Updates contact information. If the specified contact does not exist, the request will return an error. | key: updateContact
| Input | Notes | Example |
|---|---|---|
Address code address | ||
Billing Address code billingAddress | Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details). | |
Connection connection / Required connection | ||
Contact Id string contactId | The field will be set only if the contact is an individual. is_organization is set to false. | |
Customer Status string customerStatus | Customer status of the contact. Possible values: none, current, past | |
Custom Field string Key Value List customFields | Filterable custom field. | key: known_via value: tom |
Description string description | I know him via Tom | |
Email string email | mark@designservices.com | |
Facebook string facebook | mjohnson | |
Fax string fax | +44-208-1234567 | |
First Name string firstName | The field will be set only if the contact is an individual. is_organization is set to false. | |
Id string / Required id | The unique identifier of the contact. | |
Industry string industry | Design Services | |
Last Name string lastName | The field will be set only if the contact is an individual. is_organization is set to false. | |
Linkedin string linkedin | mjohnson | |
Mobile string mobile | 508-778-6516 | |
Name string name | This field will be set only if the contact is an organization. is_organization is set to true. | |
Owner Id string ownerId | 1 | |
Parent Organization Id string parentOrganizationId | 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 string phone | 508-778-6516 | |
Prospect Status string prospectStatus | current | |
Shipping Address code shippingAddress | Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details). | |
Skype string skype | mjohnson | |
Tag string Value List tags | In order to modify this, you need to supply the entire set. | contractor |
Title string title | CEO | |
Twitter string twitter | mjohnson | |
Website string website | www.designservices.com |
Update Deal
Updates deal information. | key: updateDeal
| Input | Notes |
|---|---|
Added At string addedAt | Date and time that the deal was started in UTC (ISO8601 format). |
Connection connection / Required connection | |
Contact Id string contactId | Unique identifier of a primary contact. |
Currency string currency | |
Custom Field string Key Value List customFields | |
Customized Win Likelihood string customizedWinLikelihood | User-provided win likelihood with value range 0-100. |
Estimated Close Date string estimatedCloseDate | |
Hot string hot | |
Deal ID string / Required id | The ID of the deal to update. |
Last Stage Change At string lastStageChangeAt | Date and time when the deal was moved into the current stage in UTC (ISO8601 format). |
Loss Reason Id string lossReasonId | Id of the Loss Reason. |
Name string name | |
Owner Id string ownerId | |
Source Id string sourceId | Id of the deal Source. |
Stage Id string stageId | |
Tag string Value List tags | |
Unqualified Reason Id string unqualifiedReasonId | Id of the Unqualify Reason. |
Value string value | Value of the deal. We encourage you to use a string with two decimal places. |
Update Lead
Updates lead information. | key: updateLead
| Input | Notes | Example |
|---|---|---|
Address code address | ||
Connection connection / Required connection | ||
Custom Field string Key Value List customFields | key: known_via value: tom | |
Description string description | ||
Email string email | ||
Facebook string facebook | ||
Fax string fax | ||
First Name string firstName | ||
Lead Id string / Required id | ||
Industry string industry | ||
Last Name string lastName | ||
Linkedin string linkedin | ||
Mobile string mobile | ||
Organization Name string organizationName | ||
Owner Id string ownerId | ||
Phone string phone | ||
Skype string skype | ||
Source Id string sourceId | ||
Status string status | ||
Tag string Value List tags | In order to modify, you need to supply the entire | important |
Title string title | ||
Twitter string twitter | ||
Unqualified Reason Id string unqualifiedReasonId | ||
Website string website |
Update Note
Updates note information. | key: updateNote
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Content string content | Highly important. | |
Is Important string isImportant | ||
Resource Id string resourceId | ||
Resource Type string resourceType | lead | |
Tag string Value List tags | premium | |
Type string type | regular |
Update Order
Updates order information. | key: updateOrder
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Discount string / Required discount | Overall discount on the order in percents. | 25 |
Id string / Required id | The unique identifier of the order. |
Update Task
Updates task information. | key: updateTask
| Input | Notes | Example |
|---|---|---|
Completed string completed | ||
Connection connection / Required connection | ||
Content string content | Contact Tom | |
Due Date string dueDate | 2014-09-27T16:32:56Z | |
Task ID string / Required id | The unique ID of the task. | |
Owner Id string ownerId | Defaults to the unique identifier of the user who created the task. | |
Remind At string remindAt | 2014-09-29T15:32:56Z | |
Resource Id string resourceId | 1 | |
Resource Type string resourceType | lead |
Upsert Contact
Create a new contact or update an existing, based on a value of a filter or a set of filters. At least a single filter - query parameter - is required. | key: upsertContact
| Input | Notes | Example |
|---|---|---|
Address (City) string addressCity | City name. | |
Address (Country) string addressCountry | Country name. | |
Address (Postal Code) string addressPostalCode | Zip code or equivalent | |
Billing Address code billingAddress | Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details). | |
Connection connection / Required connection | ||
Contact Id string contactId | The unique identifier of the organization that the contact belongs to. | |
Creator Id string creatorId | User ID. Returns all contacts created by that user. | |
Customer Status string customerStatus | Customer status of the contact. Possible values: none, current, past | |
Custom Field string Key Value List customFields | Filterable custom field. | key: external_id value: SKU01 |
Email string email | Email address of the contact. | |
Filter string / Required Key Value List filterableCustomFields | Filterable custom field. | key: custom_fields[referral_website] value: https://www.test.com |
First Name string firstName | First name of the contact. | |
Inclusive string inclusive | Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters. | |
Is Organization string isOrganization | Indicates whether or not this contact refers to an organization or an individual. | |
Last Name string lastName | Last name of the contact. | |
Mobile string mobile | Mobile phone number of the contact. | |
Name string name | Name of the contact. | |
Owner Id string ownerId | User ID. Returns all contacts owned by that user. | |
Parent Organization Id string parentOrganizationId | 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 string phone | Phone number of the contact. | |
Prospect Status string prospectStatus | Prospect status of the contact. Possible values: none, current, lost | |
Shipping Address code shippingAddress | Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details). |
Upsert Lead
Create a new lead or update an existing, based on a value of a filter or a set of filters. | key: upsertLead
| Input | Notes | Example |
|---|---|---|
Address[city] string addressCity | City name. | |
Address[country] string addressCountry | Country name. | |
Address[postal Code] string addressPostalCode | Zip or Postal code | |
Connection connection / Required connection | ||
Creator Id string creatorId | User ID. Returns all leads created by that user. | |
Custom Field string Key Value List customFields | Filterable custom field. | key: external_id value: SKU01 |
Email string email | Email address of the lead. | |
Filter string / Required Key Value List filterableCustomFields | Filterable custom field. | key: custom_fields[referral_website] value: https://www.test.com |
First Name string firstName | First name of the lead. | |
Inclusive string inclusive | Indicates how filters should be combine. true value, the default, uses AND logic. false value uses OR logic to combine filters. | |
Last Name string lastName | Last name of the lead. | |
Mobile string mobile | Mobile phone number of the lead. | |
Organization Name string organizationName | Organization name of the lead. | |
Owner Id string ownerId | User ID. Returns all leads owned by that user. | |
Phone string phone | Phone number of the lead. | |
Source Id string sourceId | Id of the Source. | |
Status string status | Status of the lead. |