Skip to main content
PATCH
/
customer
/
{customerId}
cURL
curl --request PATCH \
  --url https://api.slash.com/customer/{customerId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "customMetadata": {}
}
'
{
  "customer": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "address": {},
    "customMetadata": {}
  }
}

Authorizations

​
X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Path Parameters

​
customerId
string
required

Query Parameters

​
filter:legalEntityId
string

The legal entity ID. Required if authenticating with access to multiple legal entities.

Body

application/json
​
name
string

Updated display name.

​
email
string

Updated email address.

​
phone
string

Updated phone number.

​
address
IAddressModel · object
​
customMetadata
object

Updated custom metadata.

​
status
enum<string>

Updated status.

Available options:
active,
archived

Response

OK

​
customer
Customer · object
required

A customer represents a billing recipient associated with a legal entity.