Contacts

Create a new contact

Changed on

Create a contact

post/customers/{customer}/contacts

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/customers/{customer}/contacts
  • Auth
    none declared. Required headers: Authorization

Path parameters

customerstring required

The Customer ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

namestring required

Full name of this contact

emailstring required

Email address of this contact

billingPreference'PRIMARY' | 'STANDARD' | 'NONE' required

Example request

{
  "name": "John Smith",
  "email": "john.smith@example.com",
  "billingPreference": "PRIMARY"
}

Response

Created

idstring required

Unique ID

namestring required

Full name of this contact

emailstring required

Email address of this contact

billingPreference'PRIMARY' | 'STANDARD' | 'NONE' required
createdAtstring required

Time of creation. Formatted as an ISO 8601 timestamp.

updatedAtstring required

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

archivedAtstring

Time of archive. Formatted as an ISO 8601 timestamp.

Example response

{
  "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
  "name": "John Smith",
  "email": "john.smith@example.com",
  "billingPreference": "NONE",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "archivedAt": "2023-06-28T16:47:00Z"
}

Changes

  • d7ae8d55b7bfRevision changes
    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version