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.

Headers

tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Body

application/json

Request body used to create a contact resource.

Request body used to create a contact resource.

clientId
string
required

Unique identifier of the client.

Minimum string length: 1
Example:

"clnt_z2b3mo8qa5kzptgsu26q2wmh"

name
string
required

The full name of the contact.

Required string length: 1 - 255
Example:

"Jane Doe"

isDefault
boolean
required

Whether the contact is the default contact for a client.

Example:

true

salutation
string

The salutation of the contact.

Maximum string length: 50
Example:

"Ms."

firstName
string

First name of the contact when available.

Maximum string length: 255
Example:

"Jane"

middleName
string

Middle name of the contact when available.

Maximum string length: 255
Example:

"Allison"

lastName
string

Last name of the contact when available.

Maximum string length: 255
Example:

"Doe"

jobTitle
string

Job title of the contact.

Maximum string length: 255
Example:

"Procurement Lead"

email
string<email>

Primary email for the contact.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:

"jane.doe@example.com"

phone
string

Primary phone number for the contact.

Maximum string length: 50
Example:

"+1-555-1234"

order
integer

Order of the resource for sorting purposes.

Required range: 0 <= x <= 9007199254740991
Example:

13

Response

Default Response

Standard success response payload wrapped in a data property.

data
object
required

Contact resource returned by the API.