> ## Documentation Index > Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt > Use this file to discover all available pages before exploring further. # Update Buyer Profile > Updates a buyer profile's writable fields. Provide any non-empty subset of `label`, `name`, `contact`, and `shipping`. `name` and `contact` are replaced wholesale; `shipping` is merged field-by-field. **API scope required**: `agent-checkouts.buyer-profiles.update` ## OpenAPI ````yaml patch /unstable/agent-checkouts/buyer-profiles/{id} openapi: 3.0.3 info: title: Crossmint Agent Checkouts API version: unstable description: >- Drive a real, automated browser session through any merchant's checkout on behalf of a signed-in user. You hand the API a product URL, an optional natural-language instruction, and a hard maximum cost. Crossmint runs a browser through the merchant's checkout pages, pausing for *user actions* (shipping, payment, anything only a human can answer) which you respond to with values that satisfy a supplied JSON Schema. There are no webhooks in v1 — poll the checkout until it reaches a terminal state. ## Base URL `https://www.crossmint.com/api` (production) · `https://staging.crossmint.com/api` (staging) ## Authentication Every request requires **two** credentials: - `X-API-KEY` — a client-side API key (`ck_...`) with the `agent-checkouts.*` scopes. - `Authorization: Bearer ` — a JWT identifying the end user, issued by an external auth provider your project trusts. Without it the API returns `401`. This API lives under the `unstable` namespace. The schema may change — pin and re-test on upgrades. servers: - url: https://www.crossmint.com/api description: Production - url: https://staging.crossmint.com/api description: Staging security: - ApiKeyAuth: [] BearerAuth: [] tags: - name: Agent Checkouts description: Create, poll, respond to, and cancel browser-driven checkouts. - name: Buyer Profiles description: >- Subject-scoped buyer identity and shipping address the agent can prefill during a checkout run. Payment data is never stored. paths: /unstable/agent-checkouts/buyer-profiles/{id}: patch: tags: - Buyer Profiles summary: Update Buyer Profile description: >- Updates a buyer profile's writable fields. Provide any non-empty subset of `label`, `name`, `contact`, and `shipping`. `name` and `contact` are replaced wholesale; `shipping` is merged field-by-field. **API scope required**: `agent-checkouts.buyer-profiles.update` operationId: updateBuyerProfile parameters: - $ref: '#/components/parameters/BuyerProfileId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateBuyerProfileRequest' examples: Update label: summary: Rename the profile value: label: Work Update postal code: summary: Merge a single shipping field value: shipping: postalCode: EC1A 2BB responses: '200': description: Returns the updated buyer profile. content: application/json: schema: $ref: '#/components/schemas/BuyerProfile' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: BuyerProfileId: name: id in: path required: true description: The buyer profile id (returned by create). schema: type: string format: uuid schemas: UpdateBuyerProfileRequest: type: object description: >- Partial update — provide at least one field. `name` and `contact` are replaced wholesale; `shipping` is merged field-by-field. minProperties: 1 properties: label: type: string minLength: 1 maxLength: 120 description: Optional human-readable label for the profile. name: $ref: '#/components/schemas/BuyerProfileName' contact: $ref: '#/components/schemas/BuyerProfileContact' shipping: $ref: '#/components/schemas/UpdateBuyerProfileShipping' BuyerProfile: type: object description: The full buyer profile, returned by create, get, list items, and update. required: - id - shipping - createdAt - updatedAt properties: id: type: string format: uuid description: >- The buyer profile id. Pass it as `buyerProfileId` when creating a checkout. label: type: string minLength: 1 maxLength: 120 description: Optional human-readable label for the profile. name: $ref: '#/components/schemas/BuyerProfileName' contact: $ref: '#/components/schemas/BuyerProfileContact' shipping: $ref: '#/components/schemas/BuyerProfileShipping' createdAt: type: string format: date-time updatedAt: type: string format: date-time BuyerProfileName: type: object description: Optional buyer name. Both parts are optional. properties: first: type: string minLength: 1 maxLength: 100 description: Given name. last: type: string minLength: 1 maxLength: 100 description: Family name. BuyerProfileContact: type: object description: Optional buyer contact details. properties: email: type: string format: email maxLength: 254 description: Contact email address. phone: type: string minLength: 1 maxLength: 40 description: Contact phone number. UpdateBuyerProfileShipping: type: object description: >- Shipping fields to merge into the stored address. Provide at least one field; each provided field follows the same rules as on create. minProperties: 1 properties: addressLines: type: array minItems: 1 items: type: string minLength: 1 maxLength: 200 description: Positional street address lines (at least one). locality: type: string minLength: 1 maxLength: 120 description: City or locality. administrativeAreaCode: type: string minLength: 1 nullable: true description: ISO 3166-2 subdivision (state/province) code, or null. postalCode: type: string minLength: 1 nullable: true description: Postal or ZIP code, or null when the address has none. countryCode: type: string minLength: 2 maxLength: 2 pattern: ^[A-Za-z]{2}$ description: ISO 3166-1 alpha-2 country code (2 letters). BuyerProfileShipping: type: object description: >- Global shipping address. `administrativeAreaCode` and `postalCode` are nullable for global-address compatibility. required: - addressLines - locality - countryCode properties: addressLines: type: array minItems: 1 items: type: string minLength: 1 maxLength: 200 description: Positional street address lines (at least one). locality: type: string minLength: 1 maxLength: 120 description: City or locality. administrativeAreaCode: type: string minLength: 1 nullable: true description: ISO 3166-2 subdivision (state/province) code, or null. postalCode: type: string minLength: 1 nullable: true description: Postal or ZIP code, or null when the address has none. countryCode: type: string minLength: 2 maxLength: 2 pattern: ^[A-Za-z]{2}$ description: ISO 3166-1 alpha-2 country code (2 letters). Error: type: object properties: statusCode: type: integer error: type: string message: type: string responses: BadRequest: description: The request body or parameters were invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: >- Missing or invalid authentication. A valid `X-API-KEY` and `Authorization: Bearer ` are both required. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- The API key lacks the required scope, or Agent Checkouts is not enabled for this project. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: No checkout, action, or buyer profile with the given id. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: Client-side API key (`ck_...`) with the `agent-checkouts.*` scopes. BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- JWT identifying the end user, issued by an external auth provider your project trusts. ````