Convert lead with the Zendesk Sell API
Converts a lead into a contact, as a person, an organization or both depending on the lead, and by default also creates a deal for it. Returns individual_id, organization_id and deal_id of the new records in data. The activities of the lead move to them in the background.
- Identifier
- zendesk_sell_convert_lead
The request
POST https://connect.reportei.com/api/tools/zendesk_sell_convert_lead/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"data": {}
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| data | object | Yes | The conversion. |
Supported connections
Your customer connects their Zendesk Sell account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/zendesk_sell, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/zendesk_sell_convert_lead. It becomes your agent's tool definition with no conversion.
Other Zendesk Sell tools
- List leadsGETLists the leads the user can see, filtered by the arguments given, 25 per page by default. Each item has the record in data, and meta.count says how many came in the page. Page through with page and per_page.
- Create leadPOSTCreates a lead, a person or a company interested in the business, and returns it in data. Send last_name, organization_name or both.
- Update leadPUTUpdates the fields sent in data and returns the lead. Fields left out keep their values.
- List contactsGETLists the contacts the user can see, people and organizations, filtered by the arguments given, 25 per page by default. Each item has the record in data, and meta.count says how many came in the page. Page through with page and per_page.
- Create contactPOSTCreates a contact, a person or an organization, and returns it in data. A person needs last_name and an organization needs is_organization true and name.
- Update contactPUTUpdates the fields sent in data and returns the contact. Fields left out keep their values. A person cannot become an organization, or the other way around.
- List dealsGETLists the deals the user can see, filtered by the arguments given, 25 per page by default. Each item has the record in data, and meta.count says how many came in the page. Page through with page and per_page.
- Create dealPOSTCreates a deal for a contact and returns it in data. name and contact_id are required. Without stage_id, the deal starts in the first stage of the default pipeline.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
