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": {},
  "status": "active"
}
'
{
  "customer": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "status": "active",
    "phone": "<string>",
    "address": {},
    "customMetadata": {}
  }
}

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Path Parameters

customerId
string
required

Query Parameters

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.