Contacts

Retrieve all contacts

get

Retrieve all contacts.

Authorizations
ambit_access-tokenstringRequired
Query parameters
emailstringOptional

The email of the contact to retrieve.

Example: test@example.com
Responses
200

The collection of contacts.

application/json
get
/contacts

Create a contact

post

Create a contact.

Authorizations
ambit_access-tokenstringRequired
Body
emailstringRequired

The contact's email.

Example: contact@example.com
namestringRequired

The contact's name.

Example: John Doe
statusstring · enumRequired

The contact's status.

Possible values:
customFieldsobjectRequired

Custom field data for the contact.

Example: {"profession":"Career consultant","company_name":"Acme Inc."}
tagsstring[]Required

The IDs of tags to assign to the contact.

Example: ["db07bb52-1d59-48a8-8a0d-03005c997543","5ab65d05-1f7d-43a2-878e-90c69d6ad840","319d26ed-4e92-447b-b8f0-e84aba066dd1"]
Responses
post
/contacts

Retrieve a single contact

get

Retrieve a single contact by their ID.

Authorizations
ambit_access-tokenstringRequired
Path parameters
contactIdstringRequired

The ID of the contact to retrieve.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Responses
200

The contact.

application/json
get
/contacts/{contactId}

Update a contact

patch

Update a contact by their ID.

Authorizations
ambit_access-tokenstringRequired
Path parameters
contactIdstringRequired

The ID of the contact to retrieve.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Body
emailstringOptional

The contact's email.

Example: contact@example.com
namestringOptional

The contact's name.

Example: John Doe
statusstring · enumOptional

The contact's status.

Possible values:
customFieldsobjectOptional

Custom field data for the contact.

Example: {"profession":"Career consultant","company_name":"Acme Inc."}
tagsstring[]Optional

The IDs of tags to assign to the contact.

Example: ["db07bb52-1d59-48a8-8a0d-03005c997543","5ab65d05-1f7d-43a2-878e-90c69d6ad840","319d26ed-4e92-447b-b8f0-e84aba066dd1"]
Responses
200

The updated contact.

application/json
patch
/contacts/{contactId}

Delete a contact

delete

Delete a contact by their ID.

Authorizations
ambit_access-tokenstringRequired
Path parameters
contactIdstringRequired

The ID of the contact to retrieve.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Responses
200

The deleted contact.

application/json
delete
/contacts/{contactId}

Assign a tag to a contact

post

Assign a tag to a contact by their ID.

Authorizations
ambit_access-tokenstringRequired
Path parameters
contactIdstringRequired

The ID of the contact to retrieve.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Query parameters
tagIdstringRequired

The ID of the tag.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Responses
200

Tag assigned successfully.

No content

post
/contacts/{contactId}/assign-tag

No content

Unassign a tag from a contact

post

Unassign a tag from a contact by their ID.

Authorizations
ambit_access-tokenstringRequired
Path parameters
contactIdstringRequired

The ID of the contact to retrieve.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Query parameters
tagIdstringRequired

The ID of the tag.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Responses
200

Tag unassigned successfully.

No content

post
/contacts/{contactId}/unassign-tag

No content

Retrieve a contact note

get

Retrieve a contact note by their ID.

Authorizations
ambit_access-tokenstringRequired
Path parameters
contactIdstringRequired

The ID of the contact to retrieve.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Responses
200

The contact note.

application/json
get
/contacts/{contactId}/note

Update a contact note

patch

Update a contact note by their ID.

Authorizations
ambit_access-tokenstringRequired
Path parameters
contactIdstringRequired

The ID of the contact to retrieve.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c
Body
contentobjectRequired

The content of the note.

Responses
200

The updated contact note.

No content

patch
/contacts/{contactId}/note

No content

Last updated

Was this helpful?