v3-Leads

Number of APIs: 4

1. Create a lead

POST {{HOST}}/api/partner-api/v2/sales/leads

Create a sales lead.

Available Fields

• See examples for a list of available fields (multiple examples)

Required Scopes

• sales:leads:create

---

2. Get a lead

GET {{HOST}}/api/partner-api/v2/sales/leads/{{external_lead_id}}

Get a sales lead.

Required Scopes

• sales:leads:view

Notes

• Sales leads are retrieved for an external_id and a lead_source
• lead_source is determined by your API key
• You cannot retrieve other users leads in any way

---

3. Update a lead

PATCH {{HOST}}/api/partner-api/v2/sales/leads/{{external_id}}

Updates the supplied fields for a lead.

Available Fields

• close_date
• description

Required Scopes

• sales:leads:update

---

4. Cancel a lead

DELETE {{HOST}}/api/partner-api/v2/sales/leads/{{external_id}}/cancel

Cancels a lead. The lead will still be accessible, but marked with a 'Lost' status.

Required Scopes

• sales:leads:update

---