Update Buyer Profile

Update a buyer profile’s writable fields (any non-empty subset).

API scope required: agent-checkouts.buyer-profiles.update

PATCH /unstable/agent-checkouts/buyer-profiles/{id}

cURL

Change Email

curl --request PATCH \
  --url https://staging.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 '
{
  "contact": {
    "email": "[e-mail]"
  }
}
'

200

{
  "createdAt": "<string>",
  "id": "<string>",
  "shipping": {
    "addressLines": [
      "<string>"
    ],
    "countryCode": "<string>",
    "locality": "<string>",
    "administrativeAreaCode": "<string>",
    "postalCode": "<string>"
  },
  "updatedAt": "<string>",
  "contact": {
    "email": "<string>",
    "phone": "<string>"
  },
  "label": "<string>",
  "name": {
    "first": "<string>",
    "last": "<string>"
  }
}

Authorizations

apiKey & userJwtapiKey

X-API-KEY · string · header · required

API key required for authentication

Authorization · string · header · required

The end user's JWT, sent as Authorization: Bearer <JWT> together with a client-side API key. Validated against the project's external JWT configuration.

Headers

x-crossmint-user-id · string

Server-side auth only: the subject to act on behalf of, namespaced under the key's project. Defaults to a fixed service subject when omitted. Ignored for client-side (JWT) auth, where the subject comes from the token.

Path Parameters

id · string<uuid> · required

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

contact · object

Show child attributes

label · string

Required string length: 1 - 120

name · object

Show child attributes

shipping · object

Show child attributes

Response

200

application/json

Returns the updated buyer profile.

createdAt · string · required

Minimum string length: 1

id · string · required

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

shipping · object · required

Show child attributes

updatedAt · string · required

Minimum string length: 1

contact · object

Show child attributes

label · string

Required string length: 1 - 120

name · object

Show child attributes