Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

JWT issued by POST /api/v1.1/access-token/b2b. Send Authorization: Bearer <token>.

X-PARTNER-ID
string
header
required

Merchant API key (Credential.api_key). Required on every request.

Accept
string
header
required

Response format. Send application/json on every merchant API request.

Path Parameters

id
string
required

Account ULID

Body

application/json
name
string | null

Optional. New account name. Omit to leave the current name unchanged.

Required string length: 3 - 100
Example:

"John Doe"

status
enum<string> | null

Optional. Target account status. Omit to leave the current status unchanged.

Available options:
active,
inactive
Example:

"active"

invite_members
string<email>[] | null

Optional. Array of team member email addresses to grant access to this account. This replaces the entire member list — any existing members not included will lose access. Omit the field to leave current members unchanged. All emails must belong to registered members of the merchant.

Maximum array length: 50
Example:

Response

Updated

status
integer
required
Example:

200

success
boolean
required
Example:

true

data
object
required