Sign in
latestOpenAPI 3.1.02026-08-141866831.1 MB

77e4ef94fcc3

customers
public

Update Customer

Update a customer.

Scopes: customers:write

patch/v1/customers/{id}

Path parameters

idstring uuid4 required

The customer ID.

The customer ID.

Request body

metadataobject

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

  • A string with a maximum length of 500 characters
  • An integer
  • A floating-point number
  • A boolean

You can store up to 50 key-value pairs.

emailstring email nullable

The email address of the customer. This must be unique within the organization.

namestring nullable

The name of the customer.

tax_idstring nullable
localestring nullable

Locale of the customer, given as an IETF BCP 47 language tag, e.g. en, en-US or en-GB-oxendict. If null or unsupported, the locale will default to en.

external_idstring nullable

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

type'individual' | 'team'

Example request

{
  "email": "customer@example.com",
  "name": "John Doe",
  "billing_address": {
    "country": "US"
  },
  "locale": "en",
  "external_id": "usr_1337"
}

Response

Customer updated.

Customer required— unresolved $ref