Skip to main content
PUT
Update a customer (PUT)

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
integer
required

Customer's Id

Body

application/json

Request payload

first_name

First name of customer

last_name

Last name of customer

email

Email of customer

phone

Phone number of customer

account_id

A unique Account Id for customer. If empty, one is generated by the system

external_id

A unique External Id for customer that is used to identify them in external systems. Deprecated for new integrations: this v0 endpoint is superseded by PATCH /api/v2025-06/members/{member_id} (operationId admin_v2025_06_members_patch), which accepts the same external_id and is the actively-developed lane for member external IDs. The field and this endpoint remain fully supported for existing integrations; nothing about their behaviour changes.

notes

Note for customer

metadata
object | null

A JSON object that can store any custom data structure. When provided, replaces all existing metadata data.

default_address_attributes
object | null
customer_notes_attributes
(object | null)[] | null
metafields_attributes
(object | null)[] | null

Metafields for custom data storage

Response

Success

A single customer.

customer
object

A customer of the company. Every customer response carries the base fields. Some fields appear only on particular endpoints: active_subscriptions_count, inactive_subscriptions_count, metafields, member_id and jwt are added for company admins; points and attributable_rep are added by the detail, update and attributable-rep endpoints; the sponsor, rank, identity and agreement fields are added by the detail and update endpoints only.

meta
object | null