PUT
/
customers
/
{customer}
/
contacts
/
{id}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

customer
string
required

The Customer ID

id
string
required

Unique ID

Body

application/json
name
string
required

Full name of this contact

email
string
required

Email address of this contact

billingPreference
enum<string>
required

Billing preference. Whether this contact receives billing communications. Options are NONE, STANDARD or PRIMARY. For a given customer, if any contacts receive billing communications then at least one contact must be designated PRIMARY for billing.

Available options:
PRIMARY,
STANDARD,
NONE

Response

200 - application/json
id
string
required

Unique ID

name
string
required

Full name of this contact

email
string
required

Email address of this contact

billingPreference
enum<string>
required

Billing preference. Whether this contact receives billing communications. Options are NONE, STANDARD or PRIMARY. For a given customer, if any contacts receive billing communications then at least one contact must be designated PRIMARY for billing.

Available options:
PRIMARY,
STANDARD,
NONE
createdAt
string
required

Time of creation. Formatted as an ISO 8601 timestamp.

updatedAt
string
required

Time of last update. Formatted as an ISO 8601 timestamp.

archivedAt
string

Time of archive. Formatted as an ISO 8601 timestamp.

Create a new contactArchive a contact