Add a contact

Add a contact to a draft company.

Use this endpoint to add a contact the company wants Everee to reach. At least one contact, and exactly one primary contact, is required before the company can be submitted (CONTACTS and PRIMARY_CONTACT in readiness.missing).

📘

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

Primary contact

  • The first contact you add is always primary.
  • Adding a contact with 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.
404No company with this ID belongs to your partner account.
409The onboarding is no longer a DRAFT, or the contract has been signed.
422A required field is missing or malformed, for example an invalid email or phone.
Path Params
integer
required

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

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