PUT
/
customers
/
{id}
curl --request PUT \
  --url https://eu.sequencehq.com/api/customers/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "legalName": "John Doe",
  "contactName": "John Doe",
  "address": {
    "line1": "Flat 1",
    "line2": "123 Fake Street",
    "town": "New York",
    "state": "NY",
    "postcode": "AB1 2EF",
    "country": "US"
  },
  "email": "john@example.com",
  "billingEmails": [
    "exampleCorpInvoices@example.com"
  ],
  "telephone": "02010001000",
  "url": "https://example.com/",
  "label": "Example customer",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "123456789"
    },
    {
      "service": "Stripe",
      "id": "cus_OCtCxqQDgu1uX9"
    },
    {
      "service": "HubSpot",
      "id": "123456789"
    }
  ],
  "taxStatus": "TAXED",
  "customerAliases": [
    "b1c87177-088a-40ec-8917-9809343f3f9c"
  ]
}'
{
  "id": "e309e948-088e-4d77-b654-cd85498f1555",
  "createdAt": "2022-06-28T16:47:00Z",
  "legalName": "John Doe",
  "contactName": "John Doe",
  "address": {
    "line1": "Flat 1",
    "line2": "123 Fake Street",
    "town": "New York",
    "state": "NY",
    "postcode": "AB1 2EF",
    "country": "US"
  },
  "email": "john@example.com",
  "telephone": "02010001000",
  "url": "https://example.com/",
  "label": "Example customer",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "ID",
      "lastSynced": "2022-06-28T16:47:00Z"
    },
    {
      "service": "Stripe",
      "id": "cus_OCtCxqQDgu1uX9",
      "lastSynced": "2022-06-28T16:47:00Z"
    }
  ],
  "archivedAt": "2022-06-28T16:47:00Z",
  "billingEmails": [
    "exampleCorpInvoices@example.com"
  ],
  "taxStatus": "TAXED"
}

Path Parameters

id
string
required

Customer ID

Body

application/json
legalName
string
required

Legal name

contactName
string

Contact Name

address
object
required

Address

email
string
required

Email

billingEmails
string[]
required

Billing email addresses

telephone
string

Telephone

url
string

URL

label
string

Label

integrationIds
object[]

IDs in external integrations

taxStatus
enum<string>
required

Tax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
customerAliases
string[]

Customer aliases.

Response

200 - application/json
id
string
required

Unique ID

createdAt
string
required

Created at

legalName
string
required

Legal name

contactName
string

Contact Name

address
object
required

Address

email
string
required

Main contact email address

telephone
string

Telephone

url
string

URL

label
string

Label

integrationIds
object[]
required

External services which are linked to this customer

archivedAt
string

Date and time the Customer was archived

billingEmails
string[]
required

Billing email addresses

taxStatus
enum<string>
required

Tax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED