Zendesk Sell
API integration

list_all_zendesksell_contacts

List all contacts in Zendesk Sell. Returns fields such as id, name, first_name, last_name, email, phone, owner_id, and created_at in the response.

get_single_zendesksell_contact_by_id

Get a specific contact in Zendesk Sell using the required id. Returns key contact fields such as name, organization, contact details, and owner information.

create_a_zendesksell_contact

Create a new contact in Zendesk Sell. Requires name if contact is an organization or last_name if individual. Returns id, name, is_organization, owner_id, customer_status, and prospect_status in the response.

update_a_zendesksell_contact_by_id

Update a contact in Zendesk Sell using id. If the contact does not exist, an error is returned. The response includes key fields such as id, name, and updated contact details.

delete_a_zendesksell_contact_by_id

Delete an existing contact in Zendesk Sell using id. This operation permanently removes the contact and cannot be undone.

list_all_zendesksell_users

List all users in Zendesk Sell. Returns user details including id, name, email, role, status, and created_at for each user.

get_single_zendesksell_user_by_id

Get a specific user in Zendesk Sell using id. Returns fields such as id, name, email, and role for the user.

list_all_zendesksell_notes

List all notes in Zendesk Sell. Returns key fields such as id, content, resource_type, resource_id, creator_id, created_at, and updated_at for each note available to the user.

get_single_zendesksell_note_by_id

Get a specific note in Zendesk Sell by id. Returns fields such as content, resource_type, resource_id, and created_at for the note.

delete_a_zendesksell_note_by_id

Delete a specific note in Zendesk Sell using id. If the note does not exist, an error is returned. This operation cannot be undone.

update_a_zendesksell_note_by_id

Update a specific note in Zendesk Sell using id. Returns updated note fields such as id, content, tags, type, and is_important.

create_a_zendesksell_note

Create a new note in Zendesk Sell using resource_type, resource_id, and content. Returns id, content, resource_type, resource_id, and created_at fields in the response.

list_all_zendesksell_stages

List all stages in Zendesk Sell. Returns key fields including id, name, pipeline_id, category, position, likelihood, and active status for each stage.

list_all_zendesksell_tasks

List all tasks in Zendesk Sell. Returns task details including id, content, completed status, due_date, and owner information. No required parameters.

get_single_zendesksell_task_by_id

Get a single task in Zendesk Sell using id. Returns task details such as title, owner_id, due_date, and status. If the task does not exist, an error is returned.

delete_a_zendesksell_task_by_id

Delete a task in Zendesk Sell using id. If the specified task does not exist, an error is returned. This operation cannot be undone.

update_a_zendesksell_task_by_id

Update a task in Zendesk Sell using id. Returns task fields such as content, due_date, owner_id, resource_type, resource_id, completed, and remind_at in the response.

create_a_zendesksell_task

Create a new task in Zendesk Sell. Requires content. The response returns key fields such as id, content, due_date, remind_at, and resource_type for the created task. The remind_at date must be earlier than due_date.

list_all_zendesksell_leads

List all leads in Zendesk Sell. Returns lead details including id, name, organization_name, status, email, phone, and other key fields.

get_single_zendesksell_lead_by_id

Get a specific lead in Zendesk Sell using id. Returns key fields such as name, organization, contact details, and creation info.

delete_a_zendesksell_lead_by_id

Delete a lead in Zendesk Sell using id. This permanently removes the lead and cannot be undone. Returns an error if the specified lead does not exist.

create_a_zendesksell_lead

Create a new lead in Zendesk Sell. Requires either last_name for an individual or organization_name for an organization. Returns lead details including id, name, status, and owner information.

update_a_zendesksell_lead_by_id

Update a lead in Zendesk Sell using id. If the lead does not exist, an error is returned. The response includes updated lead fields such as id, first_name, last_name, organization_name, status, and tags.

list_all_zendesksell_lead_sources

List all lead-sources in Zendesk Sell. Returns fields like id, name, created_at, and updated_at for each source.

get_single_zendesksell_lead_source_by_id

Get a specific lead source in Zendesk Sell by id. Returns key fields such as name, creator_id, and created_at for the identified lead source.

create_a_zendesksell_lead_source

Create a new lead source in Zendesk Sell. Requires name, which must be unique. Returns id, creator_id, name, resource_type, created_at, and updated_at in the response.

update_a_zendesksell_lead_source_by_id

Update a specific lead source in Zendesk Sell. Requires id. Returns fields such as id, name, and resource_type reflecting the updated source details. The name must be unique.

delete_a_zendesksell_lead_source_by_id

Delete a specific lead-sources in Zendesk Sell using id. This operation removes the resource permanently and cannot be undone. Returns error if lead-source does not exist.

list_all_zendesksell_deals

List all deals in Zendesk Sell. Returns deal fields such as id, name, value, stage_id, and owner_id for each deal available to the user.

get_single_zendesksell_deal_by_id

Get details of a specific deal in Zendesk Sell using id. Returns key deal fields including name, value, stage, and owner.

create_a_zendesksell_deal

Create a new deal in Zendesk Sell. Requires name and contact_id. Returns the deal id, name, contact_id, value, currency, stage_id, and creation timestamps.

delete_a_zendesksell_deal_by_id

Delete a deal in Zendesk Sell using id. Removes all associated contacts in a single call. If the deal does not exist, an error is returned. This operation cannot be undone.

update_a_zendesksell_deal_by_id

Update a deal in Zendesk Sell using id. Returns updated deal information including name, value, currency, stage_id, owner_id, and tags. Note: the tags field replaces the existing set each time it is updated.

list_all_zendesksell_calls

List all calls in Zendesk Sell. Returns call details such as made_at, direction, duration, and associated resource information in the response.

get_single_zendesksell_call_by_id

Get details of a specific call in Zendesk Sell using id. Returns key fields such as call duration, direction, phone_number, outcome, and recorded_at for call tracking and history.

create_a_zendesksell_call

Create a call in Zendesk Sell. Requires phone_number. Returns id, phone_number, duration, and recording_url fields representing the created call’s details.

delete_a_zendesksell_call_by_id

Delete an existing call in Zendesk Sell using id. This operation permanently removes the call and cannot be undone. Returns error if the specified call does not exist.

update_a_zendesksell_call_by_id

Update a specific call in Zendesk Sell using id. Returns updated fields such as summary, outcome_id, duration, phone_number, incoming, missed, made_at, and external_id in the response.

list_all_zendesksell_lead_conversions

List all lead conversions in Zendesk Sell. Returns details including lead_id, individual_id, organization_id, deal_id, and creator_id for each conversion. Records are sorted in descending order by lead conversion ID.

create_a_zendesksell_lead_conversion

Create a lead conversion in Zendesk Sell using lead_id. Converts a lead into an individual, organization, and optionally a deal. Returns the created lead conversion record with details of newly created entities.

list_all_zendesksell_me

Get details of the authenticating user in Zendesk Sell. Returns user information such as id, name, email, and role based on the provided authentication credentials.

list_all_zendesksell_pipelines

List all pipelines in Zendesk Sell. Returns details for each pipeline including id, name, and whether it's enabled.

list_all_zendesksell_accounts

Get details of the authenticated account in Zendesk Sell. Returns key fields including account id, name, email, and role information.

list_all_zendesksell_custom_fields

List all custom fields for a specific resource type in Zendesk Sell. Requires resource_type. Returns fields including name, key, and data type for the specified resource.

list_all_zendesksell_associated_contacts

List associated contacts for a specific deal in Zendesk Sell. Requires deal_id. Returns contact_id, role, and created_at for each associated contact.

create_a_zendesksell_associated_contact

Create an associated contact in Zendesk Sell for a specific deal using deal_id and contact_id. Returns contact_id, created_at, and updated_at in the response.

delete_a_zendesksell_associated_contact_by_id

Delete an associated contact in Zendesk Sell. Requires deal_id and id. Removes the contact link from the deal. This operation cannot be undone and returns an error if the deal does not exist.

list_all_zendesksell_call_outcomes

List all call-outcomes in Zendesk Sell. Returns a list of call outcomes sorted by id in ascending order with key fields describing each outcome.

get_single_zendesksell_call_recording_by_id

Retrieve a call recording in Zendesk Sell using id. Returns the call's audio recording file in MP3 format.

list_all_zendesksell_collaborations

List all collaborations in Zendesk Sell available to the authenticated user. Returns fields such as id, creator_id, resource_id, and resource_type for each collaboration.

get_single_zendesksell_collaboration_by_id

Get a specific collaboration in Zendesk Sell using id. Returns collaboration details such as type, related resource references, and timestamps.

create_a_zendesksell_collaboration

Create a new collaboration in Zendesk Sell by providing collaborator_id, resource_id, and resource_type. Returns the created collaboration details including assigned collaborator and associated resource information.

delete_a_zendesksell_collaboration_by_id

Delete a collaboration in Zendesk Sell using id. Permanently removes the collaboration. Returns error if id does not exist.

list_all_zendesksell_deal_sources

List all deal sources in Zendesk Sell. Returns key fields including id, name, created_at, and updated_at for each deal source.

get_single_zendesksell_deal_source_by_id

Get a specific deal source in Zendesk Sell using id. Returns deal source details including id, name, and creation metadata. If the source does not exist, an error is returned.

create_a_zendesksell_deal_source

Create a new deal source in Zendesk Sell. Requires name, which must be unique. Returns the created source's id and name in the response.

update_a_zendesksell_deal_source_by_id

Update a deal source in Zendesk Sell using id. The source name must be unique. Returns updated fields including name and resource_type in the response.

delete_a_zendesksell_deal_source_by_id

Delete an existing deal source in Zendesk Sell using id. Returns an error if the specified source does not exist. This operation cannot be undone.

list_all_zendesksell_deal_unqualified_reasons

List all deal unqualified reasons in Zendesk Sell. Returns id, name, created_at, and updated_at fields for each reason.

get_single_zendesksell_deal_unqualified_reason_by_id

Get a specific deal unqualified reason in Zendesk Sell using id. Returns fields such as id, creator_id, name, created_at, and updated_at in the response.

create_a_zendesksell_deal_unqualified_reason

Create a deal unqualified reason in Zendesk Sell. Requires name. The name must be unique. Returns the created reason object with its id, name, and creation details.

update_a_zendesksell_deal_unqualified_reason_by_id

Update a deal unqualified reason in Zendesk Sell by id. Requires id. The name field must be unique. Returns updated unqualified reason data including id, creator_id, and name.

delete_a_zendesksell_deal_unqualified_reason_by_id

Delete a specific deal-unqualified-reason in Zendesk Sell using id. This action permanently removes the unqualified reason and cannot be undone. Returns an error if the id does not exist.

list_all_zendesksell_documents

List documents attached to a specific resource in Zendesk Sell. Requires resource_type and resource_id. Returns document id, name, created_at, updated_at, and associated resource details.

get_single_zendesksell_document_by_id

Get a specific document in Zendesk Sell using id. Returns id, resource_type, name, and download_url for file retrieval. Requires id.

list_all_zendesksell_lead_unqualified_reasons

List all lead unqualified reasons in Zendesk Sell. Returns each reason's id, name, and availability details.

list_all_zendesksell_line_items

List line-items for an order in Zendesk Sell. Requires order_id. Returns each line item's id, name, sku, description, value, currency, quantity, created_at, and updated_at.

get_single_zendesksell_line_item_by_id

Get a specific line item in Zendesk Sell using order_id and id. Returns details about the line item such as quantity, price, and product information.

create_a_zendesksell_line_item

Create a line item in Zendesk Sell for a given order_id. Requires order_id, product_id, and currency. Returns line item id, product details, value, variation, and currency used in the response.

update_a_zendesksell_line_item_by_id

Update a specific line item in Zendesk Sell for the given order_id and id. Returns updated fields such as value, variation, currency, and quantity for the line item.

delete_a_zendesksell_line_item_by_id

Delete a specific line-item from an order in Zendesk Sell using order_id and id. This operation permanently removes the line item and cannot be undone. Returns confirmation of deletion in the response.

list_all_zendesksell_loss_reasons

List all loss reasons in Zendesk Sell. Returns fields such as id, name, created_at, and updated_at for each loss reason.

get_single_zendesksell_loss_reason_by_id

Get a specific loss reason in Zendesk Sell using id. Returns key fields such as id, name, and active status in the response.

create_a_zendesksell_loss_reason

Create a new loss reason in Zendesk Sell. Requires unique name. Returns id and name of the created loss reason in the response.

update_a_zendesksell_loss_reason_by_id

Update a loss reason in Zendesk Sell using id. The name must be unique. Returns data including id and name of the updated loss reason.

delete_a_zendesksell_loss_reason_by_id

Delete a specific loss reason in Zendesk Sell using id. This permanently removes the record and cannot be undone. Returns an error if the reason with the provided id does not exist.

list_all_zendesksell_orders

List all orders in Zendesk Sell. Returns key fields including id, deal_id, value, and status for each order.

get_single_zendesksell_order_by_id

Get a specific order in Zendesk Sell using id. Returns key fields including deal_id, discount, and updated_at in the response.

create_a_zendesksell_order

Create an order in Zendesk Sell using deal_id. Returns details such as order id, deal_id, and discount applied.

update_a_zendesksell_order_by_id

Update an order in Zendesk Sell using id. Returns updated order fields including id and deal_id to confirm changes were applied.

delete_a_zendesksell_order_by_id

Delete an existing order in Zendesk Sell by id. Removes the order and all associated line items in a single call. This operation cannot be undone.

list_all_zendesksell_products

List all products in Zendesk Sell. Returns id, name, description, sku, active, cost, cost_currency, prices, created_at, and updated_at fields for each product.

get_single_zendesksell_product_by_id

Get details of a specific product in Zendesk Sell using id. Returns product fields such as name, description, price, and currency in the response.

create_a_zendesksell_product

Create a product in Zendesk Sell. Requires 'name' and 'prices'. Returns fields such as id, name, sku, description, cost, and prices in the response.

update_a_zendesksell_product_by_id

Update a product in Zendesk Sell using id. Returns updated product details including name, description, sku, active status, pricing information, and cost settings. Entire prices array must be provided if included.

delete_a_zendesksell_product_by_id

Delete a product in Zendesk Sell by id. This permanently removes the product from the catalog but does not affect existing orders or line items. Returns confirmation of deletion or an error if the product does not exist.

list_all_zendesksell_sequence_enrollments

List all sequence enrollments in Zendesk Sell. Returns key details about each enrollment such as id, resource_type, resource_id, and status.

get_single_zendesksell_sequence_enrollment_by_id

Get details about a specific sequence-enrollment in Zendesk Sell using id. Returns key fields such as enrollment status, sequence_id, user_id, and timestamps in the response. If the enrollment does not exist, an error is returned.

create_a_zendesksell_sequence_enrollment

Create a sequence enrollment in Zendesk Sell using sequence_id, resource_type, and resource_id. Returns details of the created enrollment including its id, sequence_id, and resource information.

update_a_zendesksell_sequence_enrollment_by_id

Update a sequence enrollment in Zendesk Sell using id. Allows changing the state of the enrollment between 'active' and 'finished'. Returns updated enrollment fields including id, sequence_id, and state.

zendesksell_sequence_enrollments_finish

Finish ongoing sequence enrollments for a given resource in Zendesk Sell. Optionally specify resource_id, resource_type, and sequence_ids to restrict which sequences are finished. Returns confirmation of completed operations.

list_all_zendesksell_sequences

List all sequences in Zendesk Sell. Returns key fields such as id, name, and steps for each sequence.

list_all_zendesksell_tags

List all tags in Zendesk Sell. Returns key fields such as tag id, name, and resource type for each tag available to the user.

get_single_zendesksell_tag_by_id

Get details of a specific tag in Zendesk Sell using the required id. Returns fields such as id and name representing the tag’s identifier and label.

create_a_zendesksell_tag

Create a tag in Zendesk Sell with required parameters name and resource_type. The name must be unique within the resource_type. Returns the created tag's details in the response.

update_a_zendesksell_tag_by_id

Update a tag in Zendesk Sell using id. Requires id. Returns updated tag details including id, name, and resource_type.

delete_a_zendesksell_tag_by_id

Delete a tag in Zendesk Sell by id. Removes the tag from all associated resources. Returns an error if the tag does not exist. This action cannot be undone.

list_all_zendesksell_text_messages

List all text messages in Zendesk Sell. Returns fields such as id, body, direction, and created_at for each text message.

get_single_zendesksell_text_message_by_id

Get a specific text message in Zendesk Sell using id. Returns details such as message content, direction, status, and timestamps. If the id does not exist, an error is returned.

list_all_zendesksell_visits

List all visits in Zendesk Sell. Returns fields such as id, visited_at, creator_id, resource_type, and outcome_id for each visit.

list_all_zendesksell_visit_outcomes

List all visit outcomes in Zendesk Sell. Returns fields like id, name, and active status for each visit outcome available to the user.