Contacts
Archive a contact
Mark a contact as archived
POST
/
customers
/
{customer}
/
contacts
/
{id}
/
archive
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}
.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-05-09
Path Parameters
customer
string
requiredThe Customer ID
id
string
requiredUnique ID
Response
200 - application/json
id
string
requiredUnique ID
name
string
requiredFull name of this contact
email
string
requiredEmail address of this contact
billingPreference
enum<string>
requiredBilling 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
requiredTime of creation. Formatted as an ISO 8601 timestamp.
updatedAt
string
requiredTime of last update. Formatted as an ISO 8601 timestamp.
archivedAt
string
Time of archive. Formatted as an ISO 8601 timestamp.