Skip to main content
PATCH
/
unstable
/
agent-checkouts
/
buyer-profiles
/
{id}
curl --request PATCH \
  --url https://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "label": "Work"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipping": {
    "addressLines": [
      "<string>"
    ],
    "locality": "<string>",
    "countryCode": "<string>",
    "administrativeAreaCode": "<string>",
    "postalCode": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "label": "<string>",
  "name": {
    "first": "<string>",
    "last": "<string>"
  },
  "contact": {
    "email": "jsmith@example.com",
    "phone": "<string>"
  }
}
{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}
{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}
{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}
{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Client-side API key (ck_...) with the agent-checkouts.* scopes.

​
Authorization
string
header
required

JWT identifying the end user, issued by an external auth provider your project trusts.

Path Parameters

​
id
string<uuid>
required

The buyer profile id (returned by create).

Body

application/json

Partial update — provide at least one field. name and contact are replaced wholesale; shipping is merged field-by-field.

​
label
string

Optional human-readable label for the profile.

Required string length: 1 - 120
​
name
object

Optional buyer name. Both parts are optional.

​
contact
object

Optional buyer contact details.

​
shipping
object

Shipping fields to merge into the stored address. Provide at least one field; each provided field follows the same rules as on create.

Response

Returns the updated buyer profile.

The full buyer profile, returned by create, get, list items, and update.

​
id
string<uuid>
required

The buyer profile id. Pass it as buyerProfileId when creating a checkout.

​
shipping
object
required

Global shipping address. administrativeAreaCode and postalCode are nullable for global-address compatibility.

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
label
string

Optional human-readable label for the profile.

Required string length: 1 - 120
​
name
object

Optional buyer name. Both parts are optional.

​
contact
object

Optional buyer contact details.