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, utilizing the obtained credentials. This integration will seamlessly link your systems, facilitating efficient data exchange and management.
| Input | Notes | Example |
|---|---|---|
| Authorize URL | https://api.getbase.com/oauth2/authorize | |
| Client ID | ||
| Client Secret | ||
| Scopes | read write profile | |
| Token URL | https://api.getbase.com/oauth2/token |
Data Sources
Select Account
Select Account | key: account | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Pipelines
Select Pipelines | key: pipelines | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Products
Select Products | key: products | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Stages
Select Stages | key: stages | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Actions
Create Contact
Create a new contact. A contact may represent a single individual or an organization. | key: createContact
| Input | Notes | Example |
|---|---|---|
| Address | ||
| Billing Address | null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details). | |
| Connection | ||
| Contact Id | The field will be set only if the contact is an individual. is_organization is set to false. | |
| Customer Status | none | |
| Custom Field | Filterable custom field. | key: known_via value: tom |
| Description | I know him via Tom | |
| mark@designservices.com | ||
| mjohnson | ||
| Fax | +44-208-1234567 | |
| First Name | The field will be set only if the contact is an individual. is_organization is set to false. | |
| Industry | 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. | |
| mjohnson | ||
| Mobile | 508-778-6516 | |
| Name | Required only if the contact is an organization. is_organization is set to true. | |
| Owner Id | Defaults to the unique identifier of the user who created the contact. | |
| 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. | |
| Phone | 508-778-6516 | |
| Prospect Status | current | |
| Shipping Address | null if contact is neither a customer nor a prospect (see customer_status and prospect_status fields for details). | |
| Skype | mjohnson | |
| Tag | In order to modify this, you need to supply the entire set. | contractor |
| Title | CEO | |
| mjohnson | ||
| Website | www.designservices.com |
Create Deal
Create a new deal. | key: createDeal
| Input | Notes | Example |
|---|---|---|
| Added At | Date and time that the deal was started in UTC (ISO8601 format). | |
| Connection | ||
| Contact Id | ||
| Currency | If omitted, currency will be set to the default currency of the account. | |
| Custom Field | ||
| Customized Win Likelihood | User-provided win likelihood with value range 0-100. | |
| Estimated Close Date | ||
| 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. | |
| Name | ||
| Owner Id | Defaults to the unique identifier of the user that the deal is created by. | |
| Source Id | Id of the deal Source. | |
| Stage Id | If omitted, the deal will be placed in the first stage of the default pipeline. | |
| Tag | ||
| Unqualified Reason Id | Id of the Unqualify Reason. | |
| 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 | ||
| Connection | ||
| Custom Field | key: known_via value: tom | |
| Description | ||
| Fax | ||
| First Name | ||
| Industry | ||
| Last Name | Required only if a lead is an individual. company_name is empty. | |
| Mobile | ||
| Organization Name | Required only if a lead is an organization. last_name is empty. | |
| Owner Id | Defaults to user's unique identifier the lead is created by. | |
| Phone | ||
| Skype | ||
| Source Id | ||
| Status | ||
| Tag | important | |
| Title | ||
| Unqualified Reason Id | ||
| Website |
Create Note
Create a new note and associate it with one resource. | key: createNote
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Content | Highly important. | |
| Is Important | ||
| Resource Id | ||
| Resource Type | lead | |
| Tag | premium | |
| Type | regular |
Create Order
Create a new order. | key: createOrder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Deal Id | The unique identifier of the deal. | |
| Discount | Overall discount on the order in percents. Defaults to 0. | 50 |
Create Task
Creates a new task. | key: createTask
| Input | Notes | Example |
|---|---|---|
| Completed | ||
| Connection | ||
| Content | Contact Tom | |
| Due Date | 2014-09-27T16:32:56Z | |
| Owner Id | Defaults to the unique identifier of the user who created the task. | |
| Remind At | 2014-09-29T15:32:56Z | |
| Resource Id | 1 | |
| Resource Type | lead |
Delete Contact
Delete an existing contact. This operation cannot be undone. | key: deleteContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Contact 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 | Example |
|---|---|---|
| Connection | ||
| Deal ID | The ID of the deal to delete. |
Delete Lead
Delete an existing lead. | key: deleteLead
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Lead ID | The ID of the lead to delete. |
Delete Note
Delete an existing note. This operation cannot be undone. | key: deleteNote
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Note 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 | Example |
|---|---|---|
| Connection | ||
| Id | The unique identifier of the order. |
Delete Task
Delete an existing task. This operation cannot be undone. | key: deleteTask
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Task 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 | Example |
|---|---|---|
| Connection | ||
| Contact ID | The unique identifier of the contact. |
Get Contacts Stream
Read the stream of contact events. | key: getContactsStream
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Deal ID | The ID of the deal to retrieve. | |
| Includes | Comma-separated list of one or more resources related to the deal. Possible values: associated_contacts |
Get Deals Stream
Read the stream of deal events. | key: getDealsStream
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Lead ID | The ID of the lead to retrieve. |
Get Leads Stream
Read the stream of lead events. | key: getLeadsStream
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| ID | Unique identifier of the note. |
Get Notes Stream
Read the stream of note events. | key: getNotesStream
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Id | The unique identifier of the order. |
Get Orders Stream
Read the stream of order events. | key: getOrdersStream
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| Position | Your client position in Firehose stream. Possible values: top/string-from-fh-api/tail | |
| 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 | Example |
|---|---|---|
| Connection | ||
| Task ID | The unique ID of the task. |
Get Tasks Stream
Read the stream of task events. | key: getTasksStream
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Limits maximum number of events in single response. | |
| 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 | Example |
|---|---|---|
| Connection |
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 | ||
| Contact Id | The unique identifier of the organization that the contact belongs to. | |
| Creator Id | User ID. Returns all contacts created by that user. | |
| Customer Status | Customer status of the contact. Possible values: none, current, past | |
| Custom Field | Filterable custom field. | key: external_id value: SKU01 |
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. | |
| Mobile | Mobile phone number of the contact. | |
| Name | Name of the contact. | |
| Owner Id | User ID. Returns all contacts owned by that user. | |
| 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. |
List Custom Fields
Returns all custom fields associated with the specified resource type. | key: listCustomFields
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Resource Type | 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 | ||
| Contact Id | Unique identifier of a primary contact. | |
| 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: 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. | |
| 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. | |
| 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. | |
| Stage Id | Id of the Stage. | |
| 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] | City name. | |
| Address[country] | Country name. | |
| Address[postal Code] | Zip or Postal code. | |
| Address[state] | State/region name. | |
| Connection | ||
| Creator Id | User ID. Returns all leads created by that user. | |
| Custom Field | Filterable custom field. | key: external_id value: SKU01 |
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. | |
| 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. | |
| Mobile | Mobile phone number of the lead. | |
| Organization Name | Organization name of the lead. | |
| Owner Id | User ID. Returns all leads owned by that user. | |
| 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. | |
| Status | Status of the lead. |
List Notes
Returns all notes available to the user, according to the parameters provided. | key: listNotes
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| 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. | |
| 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 |
List Orders
Returns all orders available to the user. | key: listOrder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| 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 |
List Pipelines
Returns all pipelines available to the user, according to the parameters provided. | key: listPipelines
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| 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 |
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 | ||
| 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 |
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 | ||
| 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. | |
| 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. | |
| 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 |
Raw Request
Send raw HTTP request To Zendesk Sell | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| 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. | 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. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. | 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. | false |
| Api Version | The version of the API to use. | v2 |
Update Contact
Updates contact information. If the specified contact does not exist, the request will return an error. | key: updateContact
| Input | Notes | Example |
|---|---|---|
| Address | ||
| Billing Address | Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details). | |
| Connection | ||
| Contact Id | The field will be set only if the contact is an individual. is_organization is set to false. | |
| Customer Status | Customer status of the contact. Possible values: none, current, past | |
| Custom Field | Filterable custom field. | key: known_via value: tom |
| Description | I know him via Tom | |
| mark@designservices.com | ||
| mjohnson | ||
| Fax | +44-208-1234567 | |
| First Name | The field will be set only if the contact is an individual. is_organization is set to false. | |
| Id | The unique identifier of the contact. | |
| Industry | Design Services | |
| Last Name | The field will be set only if the contact is an individual. is_organization is set to false. | |
| mjohnson | ||
| Mobile | 508-778-6516 | |
| Name | This field will be set only if the contact is an organization. is_organization is set to true. | |
| Owner Id | 1 | |
| 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 | 508-778-6516 | |
| Prospect Status | current | |
| Shipping Address | Can be updated if contact is either a customer or a prospect (see customer_status and prospect_status fields for details). | |
| Skype | mjohnson | |
| Tag | In order to modify this, you need to supply the entire set. | contractor |
| Title | CEO | |
| mjohnson | ||
| Website | www.designservices.com |
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 | ||
| Contact Id | Unique identifier of a primary contact. | |
| Currency | ||
| Custom Field | ||
| Customized Win Likelihood | User-provided win likelihood with value range 0-100. | |
| Estimated Close Date | ||
| Hot | ||
| Deal ID | The ID of the deal to update. | |
| 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. | |
| Name | ||
| Owner Id | ||
| Source Id | Id of the deal Source. | |
| Stage Id | ||
| Tag | ||
| Unqualified Reason Id | Id of the Unqualify Reason. | |
| 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 | ||
| Connection | ||
| Custom Field | key: known_via value: tom | |
| Description | ||
| Fax | ||
| First Name | ||
| Lead Id | ||
| Industry | ||
| Last Name | ||
| Mobile | ||
| Organization Name | ||
| Owner Id | ||
| Phone | ||
| Skype | ||
| Source Id | ||
| Status | ||
| Tag | In order to modify, you need to supply the entire | important |
| Title | ||
| Unqualified Reason Id | ||
| Website |
Update Note
Updates note information. | key: updateNote
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Content | Highly important. | |
| Is Important | ||
| Resource Id | ||
| Resource Type | lead | |
| Tag | premium | |
| Type | regular |
Update Order
Updates order information. | key: updateOrder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Discount | Overall discount on the order in percents. | 25 |
| Id | The unique identifier of the order. |
Update Task
Updates task information. | key: updateTask
| Input | Notes | Example |
|---|---|---|
| Completed | ||
| Connection | ||
| Content | Contact Tom | |
| Due Date | 2014-09-27T16:32:56Z | |
| Task ID | The unique ID of the task. | |
| Owner Id | Defaults to the unique identifier of the user who created the task. | |
| Remind At | 2014-09-29T15:32:56Z | |
| Resource Id | 1 | |
| Resource Type | 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) | 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 | ||
| Contact Id | The unique identifier of the organization that the contact belongs to. | |
| Creator Id | User ID. Returns all contacts created by that user. | |
| Customer Status | Customer status of the contact. Possible values: none, current, past | |
| Custom Field | Filterable custom field. | key: external_id value: SKU01 |
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. | |
| Mobile | Mobile phone number of the contact. | |
| Name | Name of the contact. | |
| Owner Id | User ID. Returns all contacts owned by that user. | |
| 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). |
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] | City name. | |
| Address[country] | Country name. | |
| Address[postal Code] | Zip or Postal code | |
| Connection | ||
| Creator Id | User ID. Returns all leads created by that user. | |
| Custom Field | Filterable custom field. | key: external_id value: SKU01 |
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. | |
| Mobile | Mobile phone number of the lead. | |
| Organization Name | Organization name of the lead. | |
| Owner Id | User ID. Returns all leads owned by that user. | |
| Phone | Phone number of the lead. | |
| Source Id | Id of the Source. | |
| Status | Status of the lead. |