Customers
Update customer
- Explore demo
- Speak to an expert
- Changelog
- Blog
Usage
Customers
Billing
Notifications & Webhooks
Product
Invoices
Taxes
Account
Version 2024-01-01
Latest API
All API versions
Customers
Update customer
Update the details of one of your Customers.
PUT
/
customers
/
{id}
id
string
*
id
Required
string
Customer ID
object
*
Required
object
Add Example Value
legalName
string
*
legalName
Required
string
Legal name
Add Example Value
contactName
string
contactName
string
Contact Name
Add Example Value
address
object
*
address
Required
object
Address
Add Example Value
line1
string
*
line1
Required
string
Address line 1
Add Example Value
line2
string
line2
string
Address line 2
Add Example Value
town
string
*
town
Required
string
Town or city
Add Example Value
state
enum<string>
state
enum<string>
State (required for USA only)
Add Example Value
postcode
string
*
postcode
Required
string
Postal code
Add Example Value
country
enum<string>
*
country
Required
enum<string>
Country code (ISO 3166-1 alpha-2)
Add Example Value
email
string
*
email
Required
string
Add Example Value
billingEmails
array
billingEmails
array
Billing email addresses
Add Example Value
telephone
string
telephone
string
Telephone
Add Example Value
url
string
url
string
URL
Add Example Value
label
string
label
string
Label
Add Example Value
externalIds
array
externalIds
array
IDs in external integrations
Add Example Value
taxStatus
enum<string>
*
taxStatus
Required
enum<string>
Tax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.
Add Example Value
customerAliases
array
customerAliases
array
Customer aliases.
Add Example Value
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",
"externalIds": [
{
"key": "Xero",
"value": "123456789"
},
{
"key": "Stripe",
"value": "cus_OCtCxqQDgu1uX9"
},
{
"key": "HubSpot",
"value": "123456789"
}
],
"taxStatus": "TAXED",
"customerAliases": [
"b1c87177-088a-40ec-8917-9809343f3f9c"
]
}'{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2022-06-28T16:47:00Z",
"sequenceAccountId": "25b3c342-6fa6-4375-9ed3-616f05abb77a",
"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/",
"taxStatus": "TAXED",
"label": "Example customer",
"externalIds": [
{
"key": "Xero",
"value": "ID",
"syncTime": "2022-06-28T16:47:00Z"
},
{
"key": "Stripe",
"value": "cus_OCtCxqQDgu1uX9",
"syncTime": "2022-06-28T16:47:00Z"
}
],
"archivedAt": "2022-06-28T16:47:00Z"
}Path Parameters
id
string
requiredCustomer ID
Body
application/json
legalName
string
requiredLegal name
contactName
string
Contact Name
address
object
requiredAddress
address.line1
string
requiredAddress line 1
address.line2
string
Address line 2
address.town
string
requiredTown or city
address.state
enum<string>
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, ON, PE, QC, SK address.postcode
string
requiredPostal code
address.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW email
string
requiredbillingEmails
string[]
Billing email addresses
telephone
string
Telephone
url
string
URL
label
string
Label
externalIds
object[]
IDs in external integrations
externalIds.key
enum<string>
requiredAvailable options:
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero externalIds.value
string
requiredtaxStatus
enum<string>
requiredTax 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
requiredUnique ID
createdAt
string
requiredCreated at
sequenceAccountId
string
requiredSequenceHQ Account ID
legalName
string
requiredLegal name
contactName
string
Contact Name
address
object
requiredAddress
address.line1
string
requiredAddress line 1
address.line2
string
Address line 2
address.town
string
requiredTown or city
address.state
enum<string>
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, ON, PE, QC, SK address.postcode
string
requiredPostal code
address.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW email
string
requiredMain contact email address
billingEmails
string[]
requiredBilling email addresses
telephone
string
Telephone
url
string
URL
taxStatus
enum<string>
requiredTax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.
Available options:
TAXED, TAX_EXEMPT, REVERSE_CHARGED label
string
Label
externalIds
object[]
requiredExternal services which are linked to this customer
externalIds.key
enum<string>
requiredThe connected service
Available options:
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero externalIds.value
string
requiredThe ID of the related entity in external system
externalIds.syncTime
string
requiredThe time that this was synced from the connected integration
archivedAt
string
Date and time the Customer was archived
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",
"externalIds": [
{
"key": "Xero",
"value": "123456789"
},
{
"key": "Stripe",
"value": "cus_OCtCxqQDgu1uX9"
},
{
"key": "HubSpot",
"value": "123456789"
}
],
"taxStatus": "TAXED",
"customerAliases": [
"b1c87177-088a-40ec-8917-9809343f3f9c"
]
}'{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2022-06-28T16:47:00Z",
"sequenceAccountId": "25b3c342-6fa6-4375-9ed3-616f05abb77a",
"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/",
"taxStatus": "TAXED",
"label": "Example customer",
"externalIds": [
{
"key": "Xero",
"value": "ID",
"syncTime": "2022-06-28T16:47:00Z"
},
{
"key": "Stripe",
"value": "cus_OCtCxqQDgu1uX9",
"syncTime": "2022-06-28T16:47:00Z"
}
],
"archivedAt": "2022-06-28T16:47:00Z"
}