Skip to main content
contacts

Create /contacts

Create a contact person. Required: firstname, clients (at least one client UUID). Optional: lastname, email, phone, position_title, is_primary, custom_fields. Returns record with the detail projection.

POST
/contacts

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

application/json
clientsstring[]required

Linked client UUIDs. At least one is required on create. On update, replaces the full linked-client list when sent. The first UUID is stored as the primary legacy client link.

custom_fieldsobject[]

Custom field values by slug.

emailstring

Email address.

firstnamestringrequired

First name.

is_primarystring

Whether this person is the primary contact for the linked client(s).

lastnamestring

Last name.

phonestring

Phone number.

position_titlestring

Job title / position.

Response

application/json

Success

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Still need help? Ask the team