Zendesk CRM API Integration

These are the list of integration use cases supported by Knit for Zendesk CRM API as part of the CRM category

Delete a Call

ID: delete_a_call
Operation: write
Entities: call
Summary: The 'Delete a Call' API allows agents to delete an existing call by specifying its unique identifier in the path parameter. The request requires an authorization bearer token in the headers. If the call with the specified ID does not exist, an error is returned. This operation is irreversible. The API responds with a 204 No Content status code upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Collaboration

ID: delete_a_collaboration
Operation: write
Entities: collaboration
Summary: The 'Delete a Collaboration' API allows users to delete an existing collaboration by providing the unique identifier of the collaboration in the path parameter. The request requires an authorization header with a bearer token. If the collaboration ID does not exist, an error will be returned. The operation is irreversible. A successful deletion will result in a 204 No Content response.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a contact

ID: delete_a_contact
Operation: write
Entities: contact
Summary: The 'Delete a contact' API allows agents to delete an existing contact by specifying the contact's unique identifier in the path parameter. The request requires an authorization header with a bearer token. If the contact does not exist, an error will be returned. The operation is irreversible. A successful deletion returns a 204 No Content status.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a deal

ID: delete_a_deal
Operation: write
Entities: contact, deal
Summary: The 'Delete a deal' API allows agents to delete an existing deal by specifying its unique identifier in the path parameter. The request requires an authorization bearer token in the headers. If the deal exists, it will be deleted along with all associated contacts, and a 204 No Content status will be returned. If the deal does not exist, an error will be returned. This operation is irreversible.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a lead

ID: delete_a_lead
Operation: write
Entities: lead
Summary: The 'Delete a lead' API allows agents to delete an existing lead by specifying the lead's unique identifier in the path parameter. The request must include an authorization header with a bearer token. If the lead does not exist, an error is returned. The operation is irreversible. A successful deletion returns a 204 No Content status.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a note

ID: delete_a_note
Operation: write
Entities: note
Summary: The 'Delete a note' API allows agents to delete an existing note by providing the unique identifier of the note in the path parameters. The request requires an Authorization header with a Bearer token for authentication. If the note ID does not exist, an error will be returned. This operation cannot be undone. A successful deletion will result in a 204 No Content response.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a product

ID: delete_a_product
Operation: write
Entities: product, line item, order
Summary: The 'Delete a product' API allows an account administrator to remove an existing product from the catalog using the DELETE method. The API endpoint is '/v2/products/:id', where ':id' is the unique identifier for the product. The request requires an 'Authorization' header with a Bearer token. If the product does not exist, an error is returned. Successful deletion results in a 204 No Content response, indicating that the operation cannot be undone and does not affect existing orders and line items.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a reason

ID: delete_a_reason
Operation: write
Entities: agent, loss reason
Summary: The 'Delete a reason' API allows agents to delete an existing loss reason using its unique identifier. The API requires an authorization bearer token in the headers and the unique identifier of the loss reason as a path parameter. If the specified loss reason does not exist, an error is returned. This operation is irreversible. Upon successful deletion, the API responds with a 204 No Content status, indicating that the loss reason has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a source

ID: delete_a_source
Operation: write
Entities: source
Summary: The 'Delete a source' API allows agents to delete an existing lead source by specifying its unique identifier in the query parameters. The request requires an authorization header with a bearer token. If the specified source does not exist, the request will return an error. This operation is irreversible. A successful deletion will result in a 204 No Content response.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a tag

ID: delete_a_tag
Operation: write
Entities: resource, tag
Summary: The 'Delete a tag' API allows agents to delete an existing tag by specifying its unique identifier in the path parameter. The API requires an authorization header with a bearer token. If the tag is assigned to any resources, it will be removed from all such resources. If the specified tag does not exist, an error will be returned. This operation cannot be undone. The API responds with a 204 No Content status code upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a task

ID: delete_a_task
Operation: write
Entities: task
Summary: The 'Delete a task' API allows agents to delete an existing task using its unique identifier. The API requires the task ID as a path parameter and an authorization bearer token in the headers. If the specified task does not exist, an error will be returned. This operation is irreversible. The API responds with a 204 No Content status code upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a line item

ID: delete_remove_a_line_item
Operation: write
Entities: line item, order
Summary: The 'Remove a line item' API allows agents to delete a specific line item from an order using the DELETE method. The API requires the 'order_id' and 'line_item_id' as path parameters, which are unique identifiers for the order and the line item, respectively. An authorization header with a bearer token is also required. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Remove an Associated Contact

ID: delete_remove_an_associated_contact
Operation: write
Entities: contact, deal
Summary: The 'Remove an Associated Contact' API allows agents to remove a contact associated with a specific deal using the DELETE method. The API requires the unique identifiers of both the deal and the contact as path parameters. The request must include an Authorization header with a Bearer token. If the specified deal does not exist, an error is returned. Upon successful execution, the API responds with a 204 No Content status, indicating that the operation was successful and cannot be undone.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a Call Recording

ID: get_retrieve_a_call_recording
Operation: read
Entities: call
Summary: The 'Retrieve a Call Recording' API allows agents to download a call recording in MP3 format using the unique call ID. The API requires an authorization header with a bearer token and a query parameter 'id' which is the unique identifier of the call. The response includes the audio content in MP3 format with a content-type of 'audio/mpeg'.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a Single Call

ID: get_retrieve_a_single_call
Operation: read
Entities: deal, user, call
Summary: The 'Retrieve a Single Call' API endpoint allows users to fetch details of a specific call using its unique identifier. The request requires the call ID as a path parameter and must include headers for 'Accept' and 'Authorization'. The response includes detailed information about the call, such as the user ID, summary, recording URL, outcome ID, duration, phone number, and timestamps, among other details. If the call does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single contact

ID: get_retrieve_a_single_contact
Operation: read
Entities: contact, organization, address
Summary: The 'Retrieve a single contact' API allows users to fetch details of a specific contact using a unique contact ID. The request requires an 'id' path parameter, which is the unique identifier of the contact. The request headers must include 'Accept' and 'Authorization' with a Bearer token. The response includes detailed information about the contact, such as name, contact details, social media profiles, and addresses. If the contact does not exist, an error will be returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single deal

ID: get_retrieve_a_single_deal
Operation: read
Entities: contact, deal, organization
Summary: The 'Retrieve a single deal' API endpoint allows users to fetch details of a specific deal using its unique ID. The request requires an 'id' path parameter to specify the deal and optionally accepts an 'includes' query parameter to include related resources such as associated contacts. The response returns detailed information about the deal, including its ID, creator, owner, name, value, currency, stage, and other attributes. The response is in JSON format and includes metadata about the type of resource.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single lead

ID: get_retrieve_a_single_lead
Operation: read
Entities: organization, agent, lead
Summary: The 'Retrieve a single lead' API endpoint allows users to fetch details of a specific lead using its unique ID. The request requires an 'id' path parameter, which is the unique identifier of the lead. The request headers must include 'Accept' and 'Authorization' for specifying the media type and authentication, respectively. The response includes detailed information about the lead, such as personal details, organization, contact information, and custom fields. If the lead does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single line item

ID: get_retrieve_a_single_line_item
Operation: read
Entities: line item, order
Summary: The 'Retrieve a single line item' API endpoint allows users to fetch details of a specific line item within an order using the unique line item ID. The request requires the 'order_id' and 'line_item_id' as path parameters, and the 'Accept' and 'Authorization' headers. The response includes detailed information about the line item such as its ID, name, SKU, description, value, variation, price, currency, quantity, and timestamps for creation and last update. The response headers include 'Content-Type' and 'Content-Language'.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single note

ID: get_retrieve_a_single_note
Operation: read
Entities: agent, lead, note
Summary: The 'Retrieve a single note' API endpoint allows users to fetch a specific note by its unique ID. The request requires an authorization token and the note ID as a path parameter. The response includes detailed information about the note, such as its content, creator, associated resource, importance, tags, and timestamps for creation and last update. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single order

ID: get_retrieve_a_single_order
Operation: read
Entities: deal, order
Summary: The 'Retrieve a single order' API endpoint allows users to fetch details of a specific order using its unique identifier. The request requires an 'id' path parameter, which is the unique identifier of the order. The request headers must include 'Accept' set to 'application/json' and 'Authorization' with a valid Bearer token. The response includes order details such as 'id', 'deal_id', 'discount', 'updated_at', and 'created_at', along with metadata indicating the resource type as 'order'.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single product

ID: get_retrieve_a_single_product
Operation: read
Entities: product, meta, price
Summary: The 'Retrieve a single product' API endpoint allows users to fetch details of a specific product using its unique ID. The request requires an 'id' path parameter, which is a number representing the product's unique identifier. The request headers must include 'Accept' set to 'application/json' and an 'Authorization' bearer token. The response includes detailed information about the product, such as its name, SKU, description, prices in different currencies, and other attributes. If the product does not exist, an error will be returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single reason

ID: get_retrieve_a_single_reason
Operation: read
Entities: agent, reason
Summary: The 'Retrieve a single reason' API endpoint allows users to fetch a specific loss reason by its unique identifier. The request requires an 'id' path parameter, which is the unique identifier of the loss reason. The request headers must include 'Accept' set to 'application/json' and 'Authorization' with a valid Bearer token. The response includes the loss reason details such as 'id', 'creator_id', 'name', 'created_at', and 'updated_at'. If the loss reason does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single source

ID: get_retrieve_a_single_source
Operation: read
Entities: source, lead
Summary: The 'Retrieve a single source' API endpoint allows agents to retrieve details of a single source by providing a unique identifier (id) in the path parameters. The request must include headers for 'Accept' and 'Authorization' with a Bearer token. The response includes the source details such as id, creator_id, name, resource_type, created_at, and updated_at, along with meta information. If the source with the provided id does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single tag

ID: get_retrieve_a_single_tag
Operation: read
Entities: tag, agent, resource type
Summary: The 'Retrieve a single tag' API endpoint allows users to fetch details of a specific tag using its unique ID. The request requires an 'id' query parameter, which is the unique identifier of the tag. The request headers must include 'Accept' and 'Authorization' for specifying the media type and authentication, respectively. The response includes the tag's details such as 'id', 'creator_id', 'name', 'resource_type', 'created_at', and 'updated_at', along with metadata indicating the type of the returned object.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single task

ID: get_retrieve_a_single_task
Operation: read
Entities: agent, lead, task
Summary: The 'Retrieve a single task' API endpoint allows users to fetch details of a specific task using its unique ID. The request requires an 'Accept' header specifying the media type and an 'Authorization' header with a Bearer token for authentication. The task ID is provided as a path parameter. The response includes detailed information about the task, such as its creator, owner, associated resource, completion status, due date, and timestamps for creation and updates. If the task does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single text message

ID: get_retrieve_a_single_text_message
Operation: read
Entities: contact, text message, user
Summary: This API retrieves a single text message based on the unique text message ID provided in the path parameter. It requires an 'Accept' header specifying the media type and an 'Authorization' header with a Bearer token for authentication. The response includes details of the text message such as the user ID, phone numbers, content, and timestamps for when the message was sent, updated, and created. If the text message does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single user

ID: get_retrieve_a_single_user
Operation: read
Entities: group, user, role
Summary: The 'Retrieve a single user' API endpoint allows you to fetch details of a single user by providing a unique user ID. The request requires an 'Accept' header specifying the media type and an 'Authorization' header with a Bearer token. The user ID is a required path parameter. The response includes detailed information about the user, such as their name, email, status, roles, and team information, along with metadata about the response type.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve account details

ID: get_retrieve_account_details
Operation: read
Entities: timezone, currency, account
Summary: The 'Retrieve account details' API endpoint allows users to fetch details of their account using a GET request to the '/v2/accounts/self' endpoint. The request requires an 'Accept' header specifying 'application/json' and an 'Authorization' header with a Bearer token. The response includes account details such as id, name, currency, time format, timezone, phone, subdomain, and timestamps for creation and last update. The response is in JSON format with 'Content-Type' and 'Content-Language' headers.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Call Outcomes

ID: get_retrieve_all_call_outcomes
Operation: read
Entities: contact, agent, call outcome
Summary: The 'Retrieve All Call Outcomes' API endpoint allows users to fetch all available call outcomes. The results are sorted by ID in ascending order. Users can specify query parameters such as 'page' to indicate the starting page number and 'per_page' to define the number of records per page, with a default of 25 and a maximum of 100. The API requires 'Accept' and 'Authorization' headers for the request. The response includes a list of call outcomes with details such as contact ID, role, and timestamps, along with metadata about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Calls

ID: get_retrieve_all_calls
Operation: read
Entities: resource type, call, resource id
Summary: The 'Retrieve All Calls' API endpoint allows users to retrieve all calls available to them based on the provided query parameters. The calls are sorted by the 'made_at' timestamp in descending order. Users can filter the calls by page number, number of records per page, specific call IDs, resource type, and resource ID. The response includes detailed information about each call, such as the call ID, user ID, summary, recording URL, outcome ID, duration, phone number, and timestamps. The API requires authorization via a Bearer token and returns the data in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all Collaborations

ID: get_retrieve_all_collaborations
Operation: read
Entities: resource, user, collaboration
Summary: The 'Retrieve all Collaborations' API endpoint allows users to fetch all collaborations available to them. It supports various query parameters such as 'page', 'per_page', 'ids', 'includes', 'sort_by', 'creator_id', 'resource_id', and 'resource_type' to filter and sort the results. The response includes a list of collaboration items with details like 'id', 'creator_id', 'resource_type', 'resource_id', 'collaborator_id', 'created_at', and 'updated_at'. The API is accessible to agents and requires authorization via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all Contacts

ID: get_retrieve_all_contacts
Operation: read
Entities: contact, organization, address
Summary: The 'Retrieve all Contacts' API endpoint allows users to fetch all contacts available to them based on the provided query parameters. The API supports various filters such as page number, number of records per page, sorting options, and contact attributes like name, email, and phone number. The response includes a list of contacts with detailed information such as contact ID, creator ID, owner ID, organization status, and custom fields. The API is accessible to agents and requires authorization via a bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all deal unqualified reasons

ID: get_retrieve_all_deal_unqualified_reasons
Operation: read
Entities: agent, deal unqualified reason
Summary: The 'Retrieve all deal unqualified reasons' API endpoint allows users to fetch all available deal unqualified reasons. It supports optional query parameters such as 'page', 'per_page', 'sort_by', 'ids', and 'name' to filter and sort the results. The response includes a list of deal unqualified reasons with details such as 'id', 'name', 'created_at', 'updated_at', and 'creator_id'. The API requires 'Accept' and 'Authorization' headers for successful requests.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all deals

ID: get_retrieve_all_deals
Operation: read
Entities: organization, deal, user
Summary: The 'Retrieve all deals' API endpoint allows users to fetch all deals available to them based on specified query parameters. The API supports various filters such as page number, number of records per page, sorting options, and filtering by deal attributes like creator, owner, contact, organization, and more. The response includes a list of deals with detailed information such as deal ID, creator ID, owner ID, name, value, currency, stage, and custom fields. The API is accessible to agents and requires authorization via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all lead conversions

ID: get_retrieve_all_lead_conversions
Operation: read
Entities: organization, lead conversion, individual
Summary: The 'Retrieve all lead conversions' API endpoint allows users to fetch all lead conversions available to them. The records are sorted in descending order by lead conversion ID and can be paginated using either the 'page' or 'cursor' query parameters. The 'page' parameter is limited to a maximum of 50, while the 'cursor' parameter allows for fetching subsequent records. Users can also filter results by specific conversion IDs such as 'lead_id', 'individual_id', 'organization_id', or 'deal_id'. The API requires 'Accept' and 'Authorization' headers for requests. The response includes a list of lead conversions with details such as 'id', 'lead_id', 'individual_id', 'organization_id', 'deal_id', 'creator_id', and 'created_at'. Additionally, the response provides links to related resources and a 'next_page' link for further pagination if more records are available.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all lead unqualified reasons

ID: get_retrieve_all_lead_unqualified_reasons
Operation: read
Entities: item, lead unqualified reason, meta
Summary: The 'Retrieve all lead unqualified reasons' API endpoint allows users to fetch all available lead unqualified reasons. It supports pagination through the 'page' and 'per_page' query parameters, which are optional. The response includes a list of unqualified reasons, each with details such as 'id', 'name', 'creator_id', 'created_at', and 'updated_at'. The response is structured with metadata indicating the type of collection and the count of items. This API is accessible to agents and requires an authorization token.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all leads

ID: get_retrieve_all_leads
Operation: read
Entities: custom field, lead, user
Summary: The 'Retrieve all leads' API endpoint allows users to fetch all available leads based on provided query parameters. It supports filtering by various fields such as page number, number of records per page, sorting options, lead IDs, creator and owner IDs, source ID, and lead details like first name, last name, organization name, status, email, phone, and address. The API returns a collection of leads with detailed information including contact details, organization, status, and custom fields. The response includes metadata about the collection and links for navigation.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all notes

ID: get_retrieve_all_notes
Operation: read
Entities: resource, user, note
Summary: The 'Retrieve all notes' API endpoint allows users to fetch all notes available to them based on the provided query parameters. The API supports pagination through 'page' and 'per_page' parameters, sorting with 'sort_by', and filtering by various criteria such as 'ids', 'creator_id', 'resource_type', and 'resource_id'. The response includes a list of notes with details such as 'id', 'creator_id', 'resource_type', 'content', and timestamps, along with meta information about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all orders

ID: get_retrieve_all_orders
Operation: read
Entities: agent, order, deal
Summary: The 'Retrieve all orders' API endpoint allows users to fetch all orders available to them based on the provided query parameters. The API supports pagination through 'page' and 'per_page' parameters, filtering by specific order IDs using 'ids', sorting by fields with 'sort_by', and filtering by associated deal ID with 'deal_id'. The response includes a list of order items with details such as order ID, associated deal ID, discount, and timestamps for creation and last update. The response also includes metadata about the collection, such as the total count of items and links to the current page.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all Pipelines

ID: get_retrieve_all_pipelines
Operation: read
Entities: collection, agent, pipeline
Summary: The 'Retrieve all Pipelines' API endpoint allows users to fetch all available pipelines based on the provided query parameters. Users can filter the results by page number, number of records per page, specific pipeline IDs, sorting criteria, pipeline name, and whether the pipelines are disabled or enabled. The API requires an 'Accept' header specifying the media type and an 'Authorization' header with a Bearer token. The response includes a list of pipeline items, each with details such as ID, name, creation and update timestamps, and disabled status. The response metadata provides information about the collection type, item count, and a link to the current page of results.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all products

ID: get_retrieve_all_products
Operation: read
Entities: product, collection, price
Summary: The 'Retrieve all products' API endpoint allows agents to fetch all products from the catalog based on the provided query parameters. The API supports pagination through 'page' and 'per_page' parameters, sorting with 'sort_by', and filtering by 'ids', 'name', 'sku', and 'active' status. The response includes a list of products with details such as ID, name, SKU, description, active status, prices, cost, and timestamps for creation and updates. The response also contains metadata about the collection, including the count of items and links for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all reasons

ID: get_retrieve_all_reasons
Operation: read
Entities: deal, loss reason, reason
Summary: The 'Retrieve all reasons' API endpoint allows users to fetch all deal loss reasons available to them. It supports optional query parameters such as 'page', 'per_page', 'sort_by', 'ids', and 'name' to filter and sort the results. The API requires 'Accept' and 'Authorization' headers for the request. The response includes a list of loss reasons with details like 'id', 'creator_id', 'name', 'created_at', and 'updated_at'. The response is paginated and can be sorted based on specified fields.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all sequence enrollments

ID: get_retrieve_all_sequence_enrollments
Operation: read
Entities: enrollment step, sequence, sequence enrollment
Summary: The 'Retrieve all sequence enrollments' API endpoint allows users to fetch all sequence enrollments available to them. It supports pagination through 'page' and 'per_page' query parameters, and can filter results by specific enrollment IDs, resource IDs, and resource types. The response includes detailed information about each sequence enrollment, such as the sequence details, state, current step position, and enrollment steps. The API is accessible to agents and requires authorization via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all Sequences

ID: get_retrieve_all_sequences
Operation: read
Entities: sequence, step, unsubscribe setting
Summary: The 'Retrieve all Sequences' API endpoint allows users to fetch all sequences available to them. It supports query parameters such as 'page' for pagination, 'per_page' to limit the number of records per page, 'ids' to filter by specific sequence IDs, and 'name' to search for sequences by name substring. The response includes a list of sequences with details such as ID, name, total steps, creator ID, timestamps, and unsubscribe settings. Each sequence contains steps with specific actions and properties.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all sources

ID: get_retrieve_all_sources
Operation: read
Entities: agent, deal source, resource type
Summary: The 'Retrieve all sources' API endpoint allows users to fetch all available deal sources. It supports optional query parameters such as 'page', 'per_page', 'sort_by', 'ids', and 'name' to customize the response. The API requires 'Accept' and 'Authorization' headers for the request. The response includes a list of deal sources with details like 'id', 'creator_id', 'name', 'resource_type', 'created_at', and 'updated_at'. The response also contains metadata about the collection, including the count of items and a self-link.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all stages

ID: get_retrieve_all_stages
Operation: read
Entities: pipeline, stage
Summary: The 'Retrieve all stages' API endpoint allows users to fetch all stages available to them based on the provided query parameters. The API supports filtering by pipeline ID, pagination, sorting, and filtering by stage IDs, name, and active status. The response includes a list of stages with details such as ID, name, category, position, likelihood, active status, pipeline ID, and timestamps for creation and last update. The response is paginated and includes metadata about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all tags

ID: get_retrieve_all_tags
Operation: read
Entities: resource, tag, user
Summary: The 'Retrieve all tags' API endpoint allows users to fetch all available tags based on the provided query parameters. The API supports pagination through 'page' and 'per_page' parameters, sorting via 'sort_by', and filtering by 'ids', 'creator_id', 'name', and 'resource_type'. The response includes a list of tags with details such as 'id', 'creator_id', 'name', 'resource_type', 'created_at', and 'updated_at'. The response also contains metadata about the collection, including the total count and a self-link.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all tasks

ID: get_retrieve_all_tasks
Operation: read
Entities: resource, task, user
Summary: The 'Retrieve all tasks' API endpoint allows users to fetch all tasks available to them based on specified query parameters. Users can filter tasks by page number, number of records per page, sorting fields, task IDs, creator ID, owner ID, query string, task type, resource type, resource ID, completion status, overdue status, and reminder status. The API returns a collection of tasks with detailed information about each task, including its ID, creator, owner, resource type, completion status, due date, content, and timestamps for creation and updates. The response also includes metadata about the collection, such as the total count and links to the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all text messages

ID: get_retrieve_all_text_messages
Operation: read
Entities: resource, text message
Summary: The 'Retrieve all text messages' API allows agents to fetch text messages based on various query parameters. The API endpoint is '/v2/text_messages' and it uses the GET method. The request can include query parameters such as 'page', 'per_page', 'ids', 'resource_type', 'resource_id', and 'sort_by' to filter and sort the text messages. The response includes a list of text messages with details such as 'id', 'user_id', 'user_phone_number', 'content', 'incoming', 'resource_phone_number', 'resource_type', 'resource_id', 'associated_deal_ids', 'send_at', 'updated_at', and 'created_at'. The response also includes metadata about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all users

ID: get_retrieve_all_users
Operation: read
Entities: group, user, role
Summary: The 'Retrieve all users' API endpoint allows agents to fetch a list of users based on various query parameters. The API supports filtering by page, number of records per page, sorting, user IDs, name, email, role, role ID, status, confirmation status, Zendesk user IDs, and identity type. The response includes user details such as ID, name, email, status, role, creation and update timestamps, roles, phone number, timezone, reporting structure, team name, and group information. The API returns a collection of user objects with metadata about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all visit outcomes

ID: get_retrieve_all_visit_outcomes
Operation: read
Entities: collection, agent, visit outcome
Summary: The 'Retrieve all visit outcomes' API endpoint allows users to fetch all visit outcomes available to them. It supports pagination through the 'page' and 'per_page' query parameters, where 'page' specifies the page number to start from and 'per_page' specifies the number of records to return per page. The API requires an 'Accept' header specifying the media type and an 'Authorization' header with a bearer token for authentication. The response includes a list of visit outcomes, each with an ID, name, creation timestamp, and last update timestamp, along with metadata about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve all visits

ID: get_retrieve_all_visits
Operation: read
Entities: resource, outcome, visit
Summary: The 'Retrieve all visits' API endpoint allows users to fetch all visits available to them based on the provided query parameters. The API supports pagination through 'page' and 'per_page' parameters, sorting by fields such as 'id' and 'visited_at', and filtering by various criteria including 'outcome_id', 'creator_id', 'resource_type', 'resource_id', and 'rep_location_verification_status'. The response includes a list of visits with details such as 'id', 'creator_id', 'outcome_id', 'resource_type', 'resource_id', 'visited_at', 'resource_address', 'rep_location_verification_status', 'summary', 'created_at', and 'updated_at'. The response also contains meta information about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve an authenticating user

ID: get_retrieve_an_authenticating_user
Operation: read
Entities: group, user, role
Summary: This API retrieves the details of the authenticating user based on the provided authentication credentials. It requires the 'Accept' and 'Authorization' headers to be set. The response includes detailed information about the user such as their ID, name, email, status, roles, phone number, timezone, and associated team and group information.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve custom field

ID: get_retrieve_custom_field
Operation: read
Entities: resource type, custom field, organisation
Summary: The 'Retrieve custom field' API endpoint allows users to retrieve all custom fields associated with a specified resource type. The API requires a query parameter 'resource_type' which specifies the type for which custom fields should be returned. Possible values for 'resource_type' include lead, contact, deal, and prospect_and_customer. The request must include headers for 'Accept' and 'Authorization'. The response includes a list of custom fields with details such as id, name, creation and update timestamps, applicability to organisation or contact, type, and choices if applicable. The response is structured with metadata indicating the type and count of items.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Deal's Associated Contacts

ID: get_retrieve_deals_associated_contacts
Operation: read
Entities: contact, deal, associated contact
Summary: The 'Retrieve Deal's Associated Contacts' API endpoint allows agents to retrieve all contacts associated with a specific deal. The API requires the deal ID as a path parameter and supports optional query parameters for pagination, including 'page' and 'per_page'. The response includes a list of associated contacts, each with details such as contact ID, role, and timestamps for creation and last update. The response is paginated and includes metadata about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve documents

ID: get_retrieve_documents
Operation: read
Entities: document, resource
Summary: The 'Retrieve documents' API endpoint allows users to fetch all documents attached to specific resources based on the provided query parameters. The required query parameters include 'resource_type' and 'resource_id', which specify the type and unique identifiers of the resources to search for. Optional parameters include 'page', 'per_page', 'sort_by', 'ids', and 'name', which allow for pagination, sorting, and filtering of the results. The API returns a collection of documents, each with details such as 'id', 'resource_type', 'resource_id', 'creator_id', 'name', 'content_type', 'size', 'download_url', 'created_at', and 'updated_at'. The response also includes metadata about the collection, such as the total count and a self-link to the current resource.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve order's line items

ID: get_retrieve_order_line_items
Operation: read
Entities: agent, line item, order
Summary: The 'Retrieve order's line items' API endpoint allows agents to retrieve all line items associated with a specific order. The API requires an order ID as a path parameter and supports optional query parameters such as page, per_page, sort_by, ids, quantity, and value to filter and sort the results. The request must include headers for Accept and Authorization. The response includes a list of line items with details such as id, name, sku, description, value, variation, price, currency, quantity, and timestamps for creation and last update. The response also includes metadata about the collection, such as the type, count, and links to the current page.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single Collaboration

ID: get_single_collaboration
Operation: read
Entities: agent, lead, collaboration
Summary: The 'Retrieve a single Collaboration' API endpoint allows users to fetch details of a specific collaboration using its unique ID. The request requires an 'id' path parameter, which is the unique identifier of the collaboration. The request headers must include 'Accept' and 'Authorization' for specifying the media type and authentication, respectively. The response includes details of the collaboration such as 'id', 'creator_id', 'resource_type', 'resource_id', 'collaborator_id', 'created_at', and 'updated_at'. The response headers provide information about the content type and language.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single deal unqualified reason

ID: get_single_deal_unqualified_reason
Operation: read
Entities: deal unqualified reason
Summary: This API retrieves a single deal unqualified reason by its unique identifier. The request requires an 'id' path parameter which is the unique identifier of the unqualified reason. The request headers must include 'Accept' set to 'application/json' and 'Authorization' with a Bearer token. The response includes the unqualified reason details such as 'id', 'creator_id', 'name', 'created_at', and 'updated_at'. If the unqualified reason does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve a single sequence enrollment

ID: get_single_sequence_enrollment
Operation: read
Entities: enrollment step, sequence, sequence enrollment
Summary: The 'Retrieve a single sequence enrollment' API allows users to fetch details of a specific sequence enrollment using its unique identifier. The API requires an 'id' path parameter, which is the unique identifier of the enrollment. The request must include headers for 'Accept' and 'Authorization' with a Bearer token. The response includes detailed information about the enrollment, such as the actor ID, resource type, sequence details, state, and enrollment steps. If the enrollment does not exist, an error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Call

ID: post_create_a_call
Operation: write
Entities: deal, user, call
Summary: The 'Create a Call' API allows agents to create a new call record in the system. It requires a POST request to the '/v2/calls' endpoint. The request must include headers for 'Accept', 'Content-Type', and 'Authorization'. The body of the request can include various optional parameters such as 'user_id', 'summary', 'recording_url', 'outcome_id', 'duration', 'incoming', 'missed', 'resource_type', 'resource_id', 'associated_deal_ids', 'made_at', 'updated_at', and 'external_id'. The only required parameter in the body is 'phone_number'. The response includes details of the created call, such as 'id', 'user_id', 'summary', 'recording_url', 'outcome_id', 'duration', 'phone_number', 'incoming', 'missed', 'resource_type', 'resource_id', 'associated_deal_ids', 'made_at', 'updated_at', and 'external_id', along with metadata indicating the type of resource.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Collaboration

ID: post_create_a_collaboration
Operation: write
Entities: contact, lead, collaboration
Summary: The 'Create a Collaboration' API allows users to create a new collaboration and associate it with a specified resource such as Leads, Contacts, SalesAccounts, or Deals. The API requires a POST request to the endpoint '/v2/collaborations' with headers including 'Accept', 'Content-Type', and 'Authorization'. The request body must contain 'resource_type', 'resource_id', and 'collaborator_id' within the 'data' object, and a 'meta' object specifying the type as 'collaboration'. The response includes details of the created collaboration, such as 'id', 'creator_id', 'resource_type', 'resource_id', 'collaborator_id', and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a deal

ID: post_create_a_deal
Operation: write
Entities: contact, deal, custom field
Summary: The 'Create a deal' API allows agents to create a new deal in the system. It requires the 'name' and 'contact_id' as mandatory fields in the request body. Other optional fields include 'value', 'currency', 'owner_id', 'hot', 'stage_id', 'last_stage_change_at', 'added_at', 'source_id', 'loss_reason_id', 'unqualified_reason_id', 'estimated_close_date', 'customized_win_likelihood', 'tags', and 'custom_fields'. The API responds with the details of the created deal, including its 'id', 'creator_id', 'owner_id', 'name', 'value', 'currency', 'hot', 'stage_id', 'last_stage_change_at', 'last_stage_change_by_id', 'last_activity_at', 'source_id', 'loss_reason_id', 'unqualified_reason_id', 'dropbox_email', 'contact_id', 'organization_id', 'estimated_close_date', 'tags', 'custom_fields', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a lead

ID: post_create_a_lead
Operation: write
Entities: custom field, lead, address
Summary: The 'Create a lead' API endpoint allows users to create a new lead, which can represent either an individual or an organization. The API requires either a 'last_name' for individual leads or an 'organization_name' for organizational leads. Optional fields include 'first_name', 'owner_id', 'status', 'source_id', 'unqualified_reason_id', 'title', 'description', 'industry', 'website', 'email', 'phone', 'mobile', 'fax', 'twitter', 'facebook', 'linkedin', 'skype', 'address', 'tags', and 'custom_fields'. The response includes details of the created lead, such as 'id', 'creator_id', 'owner_id', 'first_name', 'last_name', 'organization_name', 'status', 'source_id', 'title', 'description', 'industry', 'website', 'email', 'phone', 'mobile', 'fax', 'twitter', 'facebook', 'linkedin', 'skype', 'address', 'tags', 'custom_fields', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a lead conversion

ID: post_create_a_lead_conversion
Operation: write
Entities: organization, lead, individual
Summary: The 'Create a lead conversion' API endpoint allows users to convert a lead into an individual and/or an organization and optionally create a deal for the created contacts. The conversion process attaches all activities associated with the converted lead to the newly created contacts and/or deal asynchronously. The API requires the 'lead_id' as a mandatory field in the request body, while 'owner_id' and 'create_deal' are optional. The response includes details of the conversion, such as the IDs of the created individual, organization, and deal, along with metadata links to these entities.
Input Fields: Input Fields
Output Fields: Output Fields

Create a line item

ID: post_create_a_line_item
Operation: write
Entities: product, line item, order
Summary: The 'Create a line item' API allows adding a new line item to an existing order. Line items correspond to products in the catalog, and the currency parameter is required to determine the price. If neither value nor variation is specified, the default is a 0% markup, and the value is set to the product's price. If either is provided, the other is calculated based on the product's price. The API checks that the value is derived from the price with the specified variation and ensures the variation is within the product's max_discount and max_markup limits. The request requires the order_id as a path parameter and product_id, currency, and optionally value, variation, and quantity in the body. The response includes details of the created line item, such as id, name, sku, description, value, variation, price, currency, quantity, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Create a note

ID: post_create_a_note
Operation: write
Entities: contact, lead, note
Summary: The 'Create a note' API allows users to create a new note and associate it with a specified resource such as Leads, Contacts, or Deals. The API requires the resource type, resource ID, and content of the note as mandatory fields in the request body. Optional fields include a flag for importance, tags, and the type of note. The request must include headers for Accept, Content-Type, and Authorization. Upon successful creation, the API returns the details of the created note, including its ID, creator ID, associated resource details, content, importance flag, tags, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a product

ID: post_create_a_product
Operation: write
Entities: account administrator, product, price
Summary: The 'Create a product' API allows an account administrator to create a new product in the system. The API endpoint is '/v2/products' and it uses the POST method. The request must include headers for 'Accept', 'Content-Type', and 'Authorization'. The request body requires a 'data' object with a mandatory 'name' field and an array of 'prices'. Optional fields include 'sku', 'description', 'active', 'cost', 'cost_currency', 'max_discount', and 'max_markup'. The response returns the created product's details including 'id', 'name', 'sku', 'description', 'prices', 'max_discount', 'max_markup', 'cost', and 'cost_currency'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a source

ID: post_create_a_source
Operation: write
Entities: source, lead
Summary: The 'Create a source' API allows agents to create a new source with a unique name. The request must include the 'name' in the body, which is required and must be unique. Optionally, a 'resource_type' can be specified. The request headers must include 'Accept', 'Content-Type', and 'Authorization' with a Bearer token. The response returns the details of the created source, including its ID, creator ID, name, resource type, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a tag

ID: post_create_a_tag
Operation: write
Entities: tag, resource type, name
Summary: The 'Create a tag' API allows agents to create a new tag with a unique name within the scope of a specified resource type. The request requires headers for 'Accept', 'Content-Type', and 'Authorization' with a bearer token. The body must include 'data' with 'name' and 'resource_type', and 'meta' with 'type' set to 'tag'. The response returns the created tag's details including 'id', 'creator_id', 'name', 'resource_type', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a task

ID: post_create_a_task
Operation: write
Entities: contact, lead, task
Summary: The 'Create a task' API allows users to create a new task, which can be either a floating task or associated with a specific resource type such as Leads, Contacts, or Deals. The API requires the 'content' field in the request body, while other fields like 'due_date', 'owner_id', 'resource_type', 'resource_id', 'completed', and 'remind_at' are optional. The 'remind_at' date must be set earlier than the 'due_date'. The API supports different timezones in datetime fields during task creation, but this is not supported in the Search API. The response includes details of the created task, such as 'id', 'creator_id', 'owner_id', 'resource_type', 'resource_id', 'completed', 'completed_at', 'due_date', 'overdue', 'remind_at', 'content', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Create an order

ID: post_create_an_order
Operation: write
Entities: deal, order
Summary: The 'Create an order' API allows agents to create a new order by providing the deal ID and an optional discount percentage. The request must include headers for 'Accept', 'Content-Type', and 'Authorization' with a bearer token. The body of the request should contain the 'deal_id' and optionally 'discount' under 'data', and 'type' under 'meta'. The response returns the order details including 'id', 'deal_id', 'discount', 'updated_at', and 'created_at' timestamps, along with the 'type' in the 'meta' section.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Associated Contact

ID: post_create_associated_contact
Operation: write
Entities: contact, deal, role
Summary: The 'Create an Associated Contact' API allows agents to create an association between a deal and a contact, specifying the contact's role in the deal. The API requires the deal ID as a path parameter and the contact ID in the request body. The role of the contact is optional and defaults to 'involved'. The request must include headers for 'Accept', 'Content-Type', and 'Authorization'. The response includes the contact ID, role, and timestamps for creation and last update, along with metadata indicating the type of resource.
Input Fields: Input Fields
Output Fields: Output Fields

Create a deal unqualified reason

ID: post_create_deal_unqualified_reason
Operation: write
Entities: agent, deal unqualified reason
Summary: This API endpoint allows agents to create a new deal unqualified reason. The unqualified reason's name must be unique. The request requires headers for Accept, Content-Type, and Authorization with a Bearer token. The body of the request must include the name of the unqualified reason and the type of the resource. The response returns the details of the created unqualified reason, including its ID, creator ID, name, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a loss reason

ID: post_create_loss_reason
Operation: write
Entities: loss reason
Summary: The 'Create a loss reason' API allows agents to create a new loss reason with a unique name. The request must include headers for 'Accept', 'Content-Type', and 'Authorization' with a bearer token. The body of the request should contain the 'name' of the loss reason and a 'meta' object specifying the type as 'loss_reason'. The response returns the details of the created loss reason, including its ID, creator ID, name, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a sequence enrollment

ID: post_create_sequence_enrollment
Operation: write
Entities: enrollment step, sequence, sequence enrollment
Summary: The 'Create a sequence enrollment' API allows agents to enroll a resource into a sequence by providing the sequence ID, resource type, and resource ID. The API requires an authorization token and accepts JSON formatted data. The response includes details about the enrollment, such as the sequence information, state, and enrollment steps. Optional parameters include the actor ID, which specifies the user on whose behalf the sequence is executed.
Input Fields: Input Fields
Output Fields: Output Fields

Finish sequence enrollments for given resource

ID: post_finish_sequence_enrollments_for_given_resource
Operation: write
Entities: resource, sequence, enrollment
Summary: The 'Finish sequence enrollments for given resource' API allows agents to finish ongoing sequence enrollments for a specified resource, such as a lead or contact. The API endpoint is '/v2/sequence_enrollments/finish_ongoing_for_resource' and it uses the POST method. The request can include parameters like 'resource_id' (the unique identifier of the resource), 'resource_type' (the type of resource, e.g., lead or contact), and 'sequence_ids' (an optional array of sequence IDs to finish). If 'sequence_ids' is not specified, all ongoing sequences for the resource will be finished. The response includes details of the finished enrollments, such as the enrollment action, updated enrollments, and their respective states and steps.
Input Fields: Input Fields
Output Fields: Output Fields

Upsert a contact

ID: post_upsert_a_contact
Operation: write
Entities: contact, organization, address
Summary: The 'Upsert a contact' API allows users to create a new contact or update an existing one based on a set of filters. At least one filter is required as a query parameter. If multiple contacts match the filters, an error is returned. If a single contact matches, it is updated; if none match, a new contact is created. This API is useful for avoiding duplicate records and for carrying external system IDs as custom fields. The request requires headers for 'Accept', 'Content-Type', and 'Authorization'. The body can include various contact details such as 'creator_id', 'owner_id', 'is_organization', 'name', 'email', 'phone', 'address', and 'custom_fields'. The response includes the contact's details and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Upsert a deal

ID: post_upsert_a_deal
Operation: write
Entities: deal, custom field, user
Summary: The 'Upsert a deal' API allows users to create a new deal or update an existing one based on a set of filters. At least one filter is required as a query parameter. If multiple deals match the filters, an error is returned. If a single deal matches, it is updated; if none match, a new deal is created. This API is useful for avoiding duplicate records and for carrying external system IDs as custom fields. The request requires headers for 'Accept', 'Content-Type', and 'Authorization'. The body can include various optional fields such as 'creator_id', 'owner_id', 'contact_id', 'organization_id', 'hot', 'source_id', 'stage_id', 'last_stage_change_at', 'added_at', 'name', 'value', 'estimated_close_date', 'customized_win_likelihood', 'custom_fields', and 'inclusive'. The response includes details of the deal such as 'id', 'creator_id', 'owner_id', 'name', 'value', 'currency', 'hot', 'stage_id', 'last_stage_change_at', 'last_stage_change_by_id', 'last_activity_at', 'source_id', 'loss_reason_id', 'unqualified_reason_id', 'dropbox_email', 'contact_id', 'organization_id', 'estimated_close_date', 'customized_win_likelihood', 'tags', 'custom_fields', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Upsert a lead

ID: post_upsert_a_lead
Operation: write
Entities: custom field, lead, address
Summary: The 'Upsert a lead' API allows users to create a new lead or update an existing one based on specified filters. At least one filter is required as a query parameter. If multiple leads match the filters, an error is returned. If a single lead matches, it is updated; if none match, a new lead is created. This API is useful for avoiding duplicate records and for carrying external system IDs as custom fields. The request requires headers for Accept, Content-Type, and Authorization. The body can include various lead details such as creator_id, owner_id, source_id, first_name, last_name, organization_name, status, email, phone, mobile, address, and custom_fields. The response includes detailed lead information and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an order

ID: put_delete_an_order
Operation: write
Entities: line item, order
Summary: The 'Delete an order' API allows agents to delete an existing order and remove all associated line items in a single call. The API requires the unique id of the order as a path parameter and an authorization bearer token in the headers. If the specified order does not exist, the request will return an error. This operation is irreversible. The response will have a status code of 204 No Content if the deletion is successful.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Call

ID: put_update_a_call
Operation: write
Entities: resource, outcome, call
Summary: The 'Update a Call' API allows users to update an existing call record. This API is particularly useful for calls created using Sell Voice, where users can update properties such as summary, outcome_id, duration, phone_number, incoming, missed, made_at, and external_id. The API requires the call ID as a path parameter and accepts optional parameters in the request body to update the call details. The response includes the updated call details, including the call ID, user ID, summary, recording URL, outcome ID, duration, phone number, and timestamps for when the call was made and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update a contact

ID: put_update_a_contact
Operation: write
Entities: contact, organization, address
Summary: The 'Update a contact' API allows users to update the information of a contact using the PUT method at the endpoint '/v2/contacts/:id'. The API requires the contact's unique identifier as a path parameter. It accepts various optional fields in the request body, such as name, first_name, last_name, contact_id, and more, to update the contact's details. The request headers must include 'Accept', 'Content-Type', and 'Authorization' with a bearer token. The response returns the updated contact information, including fields like id, creator_id, owner_id, name, and more, along with metadata about the response.
Input Fields: Input Fields
Output Fields: Output Fields

Update a deal

ID: put_update_a_deal
Operation: write
Entities: contact, deal, stage
Summary: The 'Update a deal' API allows users to update the information of an existing deal using the PUT method. The endpoint requires the deal ID as a path parameter. The request body can include various optional fields such as name, value, currency, owner_id, hot, stage_id, last_stage_change_at, added_at, source_id, loss_reason_id, unqualified_reason_id, contact_id, estimated_close_date, customized_win_likelihood, tags, and custom_fields. The response returns the updated deal information including fields like id, creator_id, owner_id, name, value, currency, hot, stage_id, last_stage_change_at, last_stage_change_by_id, last_activity_at, source_id, loss_reason_id, unqualified_reason_id, dropbox_email, contact_id, organization_id, estimated_close_date, customized_win_likelihood, tags, custom_fields, created_at, and updated_at. The response also includes metadata about the type of resource.
Input Fields: Input Fields
Output Fields: Output Fields

Update a deal unqualified reason

ID: put_update_a_deal_unqualified_reason
Operation: write
Entities: agent, deal unqualified reason
Summary: The 'Update a deal unqualified reason' API allows agents to update the information of an existing unqualified reason by its unique identifier. The API requires the 'id' of the unqualified reason as a path parameter. The 'name' of the reason can be updated in the request body and must be unique. The request headers must include 'Accept', 'Content-Type', and 'Authorization' with a bearer token. The response includes the updated details of the unqualified reason, including its 'id', 'creator_id', 'name', 'created_at', and 'updated_at' timestamps, along with metadata about the resource type.
Input Fields: Input Fields
Output Fields: Output Fields

Update a lead

ID: put_update_a_lead
Operation: write
Entities: custom field, lead, address
Summary: The 'Update a lead' API allows users to update the information of a lead identified by a unique ID. The API requires the lead ID as a path parameter and accepts various optional fields in the request body, such as first name, last name, organization name, status, and more. The request must include headers for content type and authorization. The response returns the updated lead data, including details like name, organization, contact information, and tags, along with metadata about the response.
Input Fields: Input Fields
Output Fields: Output Fields

Update a loss reason

ID: put_update_a_loss_reason
Operation: write
Entities: loss reason
Summary: The 'Update a loss reason' API allows agents to update the information of a specific loss reason identified by its unique ID. The API requires the 'id' as a path parameter and optionally accepts a 'name' in the request body, which must be unique. The request headers must include 'Accept', 'Content-Type', and 'Authorization' with a bearer token. Upon successful update, the API returns the updated loss reason details including 'id', 'creator_id', 'name', 'created_at', and 'updated_at' in the response body, along with metadata indicating the type of resource.
Input Fields: Input Fields
Output Fields: Output Fields

Update a note

ID: put_update_a_note
Operation: write
Entities: agent, note
Summary: The 'Update a note' API allows users to update the information of an existing note identified by its ID. The API endpoint is '/v2/notes/:id' and it uses the PUT HTTP method. The request can include optional parameters such as 'resource_type', 'resource_id', 'content', 'is_important', 'tags', and 'type' in the body or query. The response returns the updated note details including 'id', 'creator_id', 'resource_type', 'resource_id', 'content', 'is_important', 'tags', 'created_at', 'updated_at', and 'type'. The response also includes meta information about the note.
Input Fields: Input Fields
Output Fields: Output Fields

Update a product

ID: put_update_a_product
Operation: write
Entities: account administrator, product, price
Summary: The 'Update a product' API allows an account administrator to update the information of a specified product using its unique identifier. The API endpoint is '/v2/products/:id' and requires a PUT request. The request must include headers for 'Accept', 'Content-Type', and 'Authorization'. The 'id' path parameter is required to identify the product. The request body can optionally include fields such as 'name', 'description', 'sku', 'active', 'max_discount', 'max_markup', 'cost', 'cost_currency', and 'prices'. The response includes the updated product details, including 'id', 'updated_at', 'created_at', 'active', 'name', 'sku', 'description', 'prices', 'max_discount', 'max_markup', 'cost', and 'cost_currency'. The response headers include 'Content-Type' and 'Content-Language'.
Input Fields: Input Fields
Output Fields: Output Fields

Update a source

ID: put_update_a_source
Operation: write
Entities: source, lead
Summary: The 'Update a source' API allows users to update the information of a specific source identified by its ID. The request requires the source ID as a path parameter and accepts optional fields in the request body such as 'name' and 'resource_type'. The 'name' must be unique. The API is accessible to agents and requires authorization via a Bearer token. The response includes the updated source details such as 'id', 'creator_id', 'name', 'resource_type', 'created_at', and 'updated_at', along with meta information.
Input Fields: Input Fields
Output Fields: Output Fields

Update a tag

ID: put_update_a_tag
Operation: write
Entities: tag, agent, resource_type
Summary: The 'Update a tag' API allows users to update the information of an existing tag by its unique identifier. The API requires the tag ID as a path parameter and accepts optional fields in the request body to update the tag's name and resource type. The request must include headers for content type and authorization. The response returns the updated tag details, including its ID, creator ID, name, resource type, and timestamps for creation and last update. The response also includes meta information about the tag.
Input Fields: Input Fields
Output Fields: Output Fields

Update a task

ID: put_update_a_task
Operation: write
Entities: resource, agent, task
Summary: The 'Update a task' API allows users to update the information of a specific task identified by its unique ID. The API endpoint is '/v2/tasks/:id' and it uses the PUT HTTP method. The request requires headers for 'Accept', 'Content-Type', and 'Authorization'. The 'id' is a required path parameter, while the request body can optionally include 'content', 'due_date', 'owner_id', 'resource_type', 'resource_id', 'completed', and 'remind_at'. The response includes headers for 'Content-Type' and 'Content-Language', and a body containing the updated task details such as 'id', 'creator_id', 'owner_id', 'resource_type', 'resource_id', 'completed', 'completed_at', 'due_date', 'overdue', 'remind_at', 'content', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Update an order

ID: put_update_an_order
Operation: write
Entities: deal, order
Summary: The 'Update an order' API allows agents to update the information of an existing order by specifying the order ID in the path parameters. The request must include a JSON body with the 'discount' field, which is required and represents the overall discount on the order in percentage. The request headers must include 'Accept', 'Content-Type', and 'Authorization' with a Bearer token. Upon successful update, the API returns the updated order details including 'id', 'deal_id', 'discount', 'updated_at', and 'created_at' in the response body, along with metadata indicating the resource type.
Input Fields: Input Fields
Output Fields: Output Fields

Update order's line item

ID: put_update_orders_line_item
Operation: write
Entities: product, line item, order
Summary: The 'Update order's line item' API allows agents to update a specific line item associated with an order. The API requires the order_id and line_item_id as path parameters to identify the order and line item to be updated. The request body can include optional parameters such as value, variation, and quantity to update the line item's details. The currency parameter is mandatory and should be specified in ISO4217 format. The API returns the updated line item details, including its id, name, sku, description, value, variation, price, currency, quantity, and timestamps for creation and last update. The response also includes meta information about the collection.
Input Fields: Input Fields
Output Fields: Output Fields

Update a sequence enrollment

ID: put_update_sequence_enrollment
Operation: write
Entities: enrollment step, sequence, sequence enrollment
Summary: The 'Update a sequence enrollment' API allows users to update the state of a sequence enrollment. The API endpoint is '/v2/sequence_enrollments/:id' and it uses the PUT method. The request requires an 'id' path parameter to specify the unique identifier of the enrollment. The request body can optionally include a 'state' parameter to change the state of the sequence to either 'active' or 'finished'. The API is accessible to agents and requires authentication via a Bearer token. The response includes detailed information about the sequence enrollment, including its current state, associated sequence details, and enrollment steps.
Input Fields: Input Fields
Output Fields: Output Fields