PATCH
/
customers
/
{id}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

id
string
required

The unique identifier of the customer in Dub.

Query Parameters

includeExpandedFields
boolean

Whether to include expanded fields on the customer (link, partner, discount).

Body

application/json
avatar
string | null

Avatar URL of the customer in the client's app.

email
string | null

Email of the customer in the client's app.

externalId
string

Unique identifier for the customer in the client's app.

name
string | null

Name of the customer in the client's app. If not provided, a random name will be generated.

Response

200 - application/json
createdAt
string
required

The date the customer was created.

externalId
string
required

Unique identifier for the customer in the client's app.

id
string
required

The unique identifier of the customer in Dub.

name
string
required

Name of the customer.

avatar
string | null

Avatar URL of the customer.

country
string | null

Country of the customer.

discount
object | null
email
string | null

Email of the customer.

partner
object | null