Authentication
Send the same App Id and App Secret as the rest of the API, in thex-api-key and x-api-secret headers. Every request works on the workspace that owns the app. Records created through the API are recorded as created by the app’s user.
Base URL
Responses
A successful call answers{ "success": true, "data": ... }. A failed call answers { "success": false, "error": "..." } with a 4xx status:
Lists take
page and perPage (at most 100) and answer { items, total, page, perPage }.
Referring to records
- Contacts: by id, or by phone number with the country code (
919876543210; spaces,+and dashes are ignored). - Contact fields: by attribute title, such as
FIRSTNAMEorCITY. Get the titles from List Attributes. - Labels, lists and pipelines: by name or id.
- Stages: by title, such as
Qualified, or id. - Users (assignee, owner): by their email address.
Keeping contacts in sync
Create or Update a Contact finds the contact by phone, then by email, and creates it when there is none. Sending the same body twice is safe. Use it whenever someone signs up or fills a form on your side.Workflows tell a new contact from an updated one by its timestamps. If you update a contact within a fraction of a second after creating it, that update can start your “contact created” workflows a second time. Send everything in one create call when you can.