v50

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-06-1841147599.2 KB
Contacts

Create a contact

Creates a new contact by phone number and associates it with the authenticated customer.

post/v3/contacts

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

phone_numberstring required

Phone number of the contact to create

Example request

{
  "phone_number": "+1234567890",
  "sandbox": false
}

Response

Contact created successfully

successboolean

Indicates whether the request was successful