Μετάβαση στο περιεχόμενο
Προγραμματιστές

Endpoints

Contacts

Create, find, update, tag, stage and merge the people your business talks to.

Οι διαδρομές είναι σχετικές με το βασικό URL. Κάθε κάρτα δείχνει το δικαίωμα που απαιτεί η κλήση και κάθε παράμετρο, με τον τύπο και τα όριά της.

GET
/contacts

Search contacts, newest first.

Δικαίωμα: contacts
Με σελιδοποίηση

Παράμετροι query

  • qπροαιρετικόstring

    Free-text search across name, email, phone, WhatsApp number, notes and Instagram username. Every word must match. Up to 200 characters.

  • phoneπροαιρετικόstring

    Exact phone or WhatsApp number match.

  • emailπροαιρετικόstring

    Exact email match.

  • tagπροαιρετικόstring

    Contacts that carry this tag (case-insensitive).

  • stage_idπροαιρετικόinteger

    Contacts in this funnel stage.

  • assigned_to_user_idπροαιρετικόstring

    Contacts owned by this team member.

  • channelπροαιρετικόenum

    Contacts that came from this channel.

    Επιτρεπτές τιμές:instagramfacebooktiktokwhatsapptelegramemailwidgetapivoicesms

  • updated_sinceπροαιρετικόstring (ISO 8601 date-time with offset)

    Contacts updated at or after this time.

GET
/contacts/lookup

Find one contact by phone, email or channel username. Send at least one of phone, email or handle.

Δικαίωμα: contacts

Παράμετροι query

  • phoneπροαιρετικόstring

    Phone or WhatsApp number.

  • emailπροαιρετικόstring

    Email address.

  • handleπροαιρετικόstring

    Channel username, with or without "@".

  • channelπροαιρετικόenum

    Limit the handle search to one channel.

    Επιτρεπτές τιμές:instagramtiktoktelegramwhatsapp

  • Answers 404 not_found when nothing matches. When several contacts match, the oldest one is returned.
POST
/contacts

Create a contact.

Δικαίωμα: contacts

Σώμα JSON

  • first_nameπροαιρετικόstring | null

    1–100 characters.

  • last_nameπροαιρετικόstring | null

    1–100 characters.

  • emailπροαιρετικόstring | null

    Valid email address, up to 320 characters. Stored lowercase.

  • phoneπροαιρετικόstring | null

    3–50 characters. E.164 (+14155550123) recommended.

  • whatsapp_phoneπροαιρετικόstring | null

    WhatsApp number, 3–50 characters.

  • instagram_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • tiktok_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • telegram_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • country_codeπροαιρετικόstring

    Two-letter ISO 3166-1 country code, e.g. "US".

  • custom_fieldsπροαιρετικόobject

    Custom field values keyed by custom field key (see GET /custom-fields). Merged into existing values. Unknown, archived or wrongly typed keys answer 422.

  • sourceπροαιρετικόstring

    Where the contact came from, up to 50 characters. Default "api".

  • tagsπροαιρετικόarray of strings

    Up to 100 tag names (1–80 characters each). Tags that do not exist yet are added to the workspace.

  • stage_idπροαιρετικόinteger

    Funnel stage to place the contact in (see GET /funnels).

  • assigned_to_user_idπροαιρετικόstring

    Team member who owns the contact (see GET /users).

  • Answers 201 with the contact.
POST
/contacts/upsert

Update the matching contact, or create it. Matches by phone (or whatsapp_phone), then email, then Instagram, TikTok or Telegram username.

Δικαίωμα: contacts

Σώμα JSON

  • first_nameπροαιρετικόstring | null

    1–100 characters.

  • last_nameπροαιρετικόstring | null

    1–100 characters.

  • emailπροαιρετικόstring | null

    Valid email address, up to 320 characters. Stored lowercase.

  • phoneπροαιρετικόstring | null

    3–50 characters. E.164 (+14155550123) recommended.

  • whatsapp_phoneπροαιρετικόstring | null

    WhatsApp number, 3–50 characters.

  • instagram_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • tiktok_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • telegram_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • country_codeπροαιρετικόstring

    Two-letter ISO 3166-1 country code, e.g. "US".

  • custom_fieldsπροαιρετικόobject

    Custom field values keyed by custom field key (see GET /custom-fields). Merged into existing values. Unknown, archived or wrongly typed keys answer 422.

  • sourceπροαιρετικόstring

    Where the contact came from, up to 50 characters. Default "api".

  • tagsπροαιρετικόarray of strings

    Up to 100 tag names (1–80 characters each). Tags that do not exist yet are added to the workspace.

  • stage_idπροαιρετικόinteger

    Funnel stage to place the contact in (see GET /funnels).

  • assigned_to_user_idπροαιρετικόstring

    Team member who owns the contact (see GET /users).

  • Send at least a phone, email or channel username to match on (422 otherwise).
  • Answers { object: "contact_upsert", created, contact }: 201 when created, 200 when updated.
POST
/contacts/merge

Merge a duplicate contact into another. The secondary contact's records (conversations, bookings, orders and more) move to the primary one.

Δικαίωμα: contacts

Σώμα JSON

  • primary_contact_idυποχρεωτικόinteger

    The contact that stays.

  • secondary_contact_idυποχρεωτικόinteger

    The duplicate that is merged away. Must differ from primary_contact_id.

GET
/contacts/:id

Retrieve a contact, including tags, stage, assignee and custom fields.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

PATCH
/contacts/:id

Update contact fields. Fields you leave out keep their value; null clears a field.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

Σώμα JSON

  • first_nameπροαιρετικόstring | null

    1–100 characters.

  • last_nameπροαιρετικόstring | null

    1–100 characters.

  • emailπροαιρετικόstring | null

    Valid email address, up to 320 characters. Stored lowercase.

  • phoneπροαιρετικόstring | null

    3–50 characters. E.164 (+14155550123) recommended.

  • whatsapp_phoneπροαιρετικόstring | null

    WhatsApp number, 3–50 characters.

  • instagram_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • tiktok_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • telegram_usernameπροαιρετικόstring | null

    Up to 100 characters. A leading "@" is removed.

  • country_codeπροαιρετικόstring

    Two-letter ISO 3166-1 country code, e.g. "US".

  • custom_fieldsπροαιρετικόobject

    Custom field values keyed by custom field key (see GET /custom-fields). Merged into existing values. Unknown, archived or wrongly typed keys answer 422.

DELETE
/contacts/:id

Delete a contact and the data derived from it, the same way a delete in the app does.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

GET
/contacts/:id/channels

List the channel identities a contact can be reached on.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

POST
/contacts/:id/tags

Add tags to a contact. Tags that do not exist yet are added to the workspace.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

Σώμα JSON

  • tagsυποχρεωτικόarray of strings

    1–100 tag names, 1–80 characters each.

DELETE
/contacts/:id/tags

Remove tags from a contact (case-insensitive). The tags stay in the workspace.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

Σώμα JSON

  • tagsυποχρεωτικόarray of strings

    1–100 tag names.

PUT
/contacts/:id/stage

Move a contact to a funnel (lifecycle) stage.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

Σώμα JSON

  • stage_idυποχρεωτικόinteger

    Target stage (see GET /funnels).

  • funnel_idπροαιρετικόinteger

    Optional check: the stage must belong to this funnel.

DELETE
/contacts/:id/stage

Remove the contact from its lifecycle stage.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

PUT
/contacts/:id/assignee

Assign the contact to a team member, or unassign it.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

Σώμα JSON

  • user_idπροαιρετικόstring | null

    A user from GET /users. Omit or send null to unassign.

GET
/contacts/:id/notes

List the internal notes on a contact, newest first.

Δικαίωμα: contacts
Με σελιδοποίηση

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

POST
/contacts/:id/notes

Add an internal note to a contact. Customers never see notes.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

Σώμα JSON

  • bodyυποχρεωτικόstring

    1–10,000 characters.

PUT
/contacts/:id/dnc

Turn do-not-contact on or off for a contact.

Δικαίωμα: contacts

Παράμετροι διαδρομής

  • idυποχρεωτικόinteger

    Contact ID.

Σώμα JSON

  • do_not_contactυποχρεωτικόboolean

    true opts the contact out of messages.

  • reasonπροαιρετικόstring

    Up to 200 characters.

GET
/funnels

List funnels with their stages, for use with stage_id.

Δικαίωμα: contacts

Παράμετροι query

  • flatπροαιρετικόstring

    "true" returns one row per stage (funnel name › stage name) instead of nested funnels.