Update a contact

Replace a contact's details on a draft company.

Use this endpoint to change a contact. It replaces the contact's details, so send every field.

📘

Part of Company contacts. For how this fits into onboarding, see the guide: Collecting company information: contacts.

Primary contact

primary is replaced like every other field. Omitting it, or sending false, for the company's current primary contact leaves the company with no primary contact, and PRIMARY_CONTACT will appear in readiness.missing until you make a contact primary. Sending primary: true makes every other contact non-primary.

When you can call this

Only while the onboarding is a DRAFT and the contract documents haven't been signed. Otherwise it returns 409.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404The company or the contact wasn't found.
409The onboarding is no longer a DRAFT, or the contract has been signed.
422A required field is missing or malformed.
Path Params
integer
required

The company's ID, as returned when the company was created.

integer
required

The contact's ID.

Body Params
string
enum
required

The contact's role at the company.

string
required

The contact's full name.

string
required
string
required

10-digit US phone number. Formatting characters are allowed.

boolean

Whether this is the company's primary contact. Making a contact primary makes every other contact non-primary. The first contact you add is always primary. Defaults to false.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json