Skip to main content
PATCH
/
v1
/
customers
/
{customerId}
Update Customer
curl --request PATCH \
  --url https://api.monk.com/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "legalName": "<string>",
  "tags": [
    "<string>"
  ],
  "externalCustomerId": "<string>",
  "paymentProviderId": "<string>",
  "provider": "stripe",
  "paymentMethodId": "<string>",
  "paymentMethodType": "card"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "legalName": "<string>",
    "tags": [
      "<string>"
    ],
    "isPaused": true,
    "pausedAt": "<string>",
    "metadata": {
      "externalCustomerId": "<string>",
      "externalCompanyIds": [
        "<string>"
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
Scope: customers:write

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerId
string
required

Body

application/json
​
name
string
​
legalName
string | null

Pass null to clear

​
tags
string[]

Replaces existing tags

​
externalCustomerId
string
​
paymentProviderId
string

Stripe customer ID (cus_xxx). Requires provider.

​
provider
enum<string>

Payment provider. Requires paymentProviderId.

Available options:
stripe
​
paymentMethodId
string

Stripe Payment Method ID (pm_xxx). Sets the customer's default payment method on file. Monk retrieves payment method details (last4, brand, type) from Stripe automatically. Requires paymentMethodType. Requires the org to have a Stripe integration configured.

​
paymentMethodType
enum<string>

Type of payment method. Required when paymentMethodId is provided.

Available options:
card,
us_bank_account

Response

Customer updated

​
data
object