Skip to main content
POST
Create contact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
phoneNumber
object[]
required

One or more phone-number entries; each value is normalized to E.164 server-side and must be unique within the organization.

firstName
string

Contact first name; optional.

lastName
string

Contact last name; optional.

email
string<email>

Email entries for the contact; normalized server-side. Accepts the same array shape as phoneNumber despite the OpenAPI type.

process
string

Optional process/workflow tag carried through to the created contact.

status
string

Initial pipeline status name (e.g. New Lead). Defaults to the pipeline's first stage when omitted.

pipelineStage
string

Stage _id within the pipeline. Resolved together with status server-side.

pipelineId
string

Target Contact pipeline _id. Defaults to the org's active Contact pipeline when omitted.

Response

Contact created

success
enum<boolean>
required
Available options:
true
data
object
required
message
string
contact
object
Example: