How the API fits together

A contact is the person or business you work with. A lead inquiry is a specific interaction with that contact. Understanding the difference helps you update the right record.

Contacts and lead inquiries

Contacts hold details such as names, phone numbers, email addresses, notes, and pipeline status. Existing API paths and payloads use clients and clientId for these records.

Lead inquiries represent interactions such as a website conversation, phone call, or marketplace lead. A contact can have multiple lead inquiries. Use the IDs returned by the API rather than assuming a contact ID and a lead ID are interchangeable.

Created and completed events

A lead created payload contains the information available when the lead first arrives. A conversation completed payload contains the information collected through the conversation.

Choose the event that matches your workflow. An initial lead event does not mean qualification or booking has finished.

API versions

The version is part of each endpoint path. V1 and V2 endpoints coexist; a V1 endpoint is not automatically obsolete. Check the specific operation's request and response schema.

For new webhook integrations, use V2 webhooks. V1 webhook operations remain documented for existing integrations under Legacy webhooks.

REST API and browser widgets

Use the REST API from your server with an API key. Website widgets use their own browser JavaScript APIs and company or agency identifiers. They do not require you to expose your REST API key.

See Website widgets for the available methods and their differences.

Operations that take action

Read the description and prerequisites before calling an endpoint. Some operations update contacts, register webhook destinations, initiate messages, or trigger review requests.

The lead qualifier trigger requires account approval and the prerequisites listed in its reference. A successful acceptance response does not guarantee that a message has already been delivered. See Trigger lead qualifier agent.