Skip to main content
POST
Add a contact

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Body

application/json

A new contact; give at least a first or last name.

first_name
string | null

First name.

Maximum string length: 255
Pattern: ^[^\u0000]*$
last_name
string | null

Last name.

Maximum string length: 255
Pattern: ^[^\u0000]*$
email
string | null

Email address.

Maximum string length: 255
Pattern: ^[^\u0000]*$
phone
string | null

Phone number.

Maximum string length: 50
Pattern: ^[^\u0000]*$
status
string | null

Pipeline status.

Maximum string length: 50
Pattern: ^[^\u0000]*$
source
string | null

Where the contact came from.

Maximum string length: 255
Pattern: ^[^\u0000]*$
time_zone
string | null

Time zone.

Maximum string length: 255
Pattern: ^[^\u0000]*$
address
object | null

Postal address; null clears it.

Response

The new contact.

One contact.

status
integer
required
data
object
required

A contact with its address and maintained counters.

meta
object
required

Envelope metadata present on every response.