Create a contact
Creates a contact for an organization.
Only `type` is required; every other field is optional.
<Tip>
A contact's type is fixed at creation and cannot be changed later, so create a separate contact if you need a different type.
</Tip>
<Info>
Up to 10 addresses per type can be saved in the account.
</Info>
<Warning>
ID and `organisation_id` must not be specified, neither in query string, nor in JSON payload.
</Warning>
Authentication
AuthorizationBearer
An auth_token should be provided to authenticate a session.
To obtain an auth_token, see the /api/v1/authenticate POST request.
Path parameters
org_id
Unique numeric ID of an organization.
Request
This endpoint expects an object.
type
Type of contact to create, provided as an object containing the type id.
This is the only required field, and the type is fixed at creation and cannot be changed afterward.
name
First and last name of the contact.
title
Honorific or professional title of the contact, for example Dr or Ing.
department
Department the contact belongs to.
is_default
Whether this contact should be set as the default contact of its type for the organisation.
street
Street name and number of the contact's address.
zipcode
Postal or ZIP code of the contact's address.
city
City of the contact's address.
country
Contact's country, provided as an object containing the country ID.
email
Email address of the contact.
phone
Phone number of the contact.
mobile
Mobile phone number of the contact.
state
State or province of the contact's address.
secondary_address
Secondary address line, for example apartment or building number.
purchase_order_number
Purchase order number shown on the organization's monthly invoices.
<Tip>
Set `purchase_order_number` only on invoice contacts (type `6`).
When set, it appears on the organization's monthly invoices.
</Tip>
Response headers
Location
URL of the newly created contact.
Response
The contact was created successfully.
The response contains the created contact, including its generated contact_id.
id
Unique ID of this contact.
organisation
type
name
First and last name of the contact.
title
Honorific or professional title of the contact, for example Dr or Ing.
department
Department the contact belongs to.
is_default
Whether this contact should be set as the default contact of its type for the organisation
street
Street name and number of the contact's address.
zipcode
Postal or ZIP code of the contact's address.
city
City of the contact's address.
country
email
Email address of the contact.
phone
Phone number of the contact.
mobile
Mobile phone number of the contact.
state
State or province of the contact's address.
secondary_address
Secondary address line of the contact (for example, apartment, building number, etc.).
purchase_order_number
Purchase order number displayed on the monthly invoices.
contact_id
ID of the created contact, returned as a string.