---
title: "Update commerce integration"
method: PATCH
path: "/integrations/commerce/{external_business_id}"
tags: ["integrations"]
---

# Update commerce integration

`PATCH /integrations/commerce/{external_business_id}`

Update commerce integration metadata for the given external business ID. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.

## Path parameters

- `external_business_id` string, required

## Request body

- IntegrationMetadataUpdate — Resource create or update operation model.
  - `additional_id_1` string
  - `connected_advertiser_id` string
  - `connected_lba_id` string
  - `connected_merchant_id` string
  - `connected_tag_id` string
  - `partner_access_token` string
  - `partner_access_token_expiry` number
  - `partner_metadata` string
  - `partner_primary_email` string
  - `partner_refresh_token` string
  - `partner_refresh_token_expiry` number
  - `scopes` string

## Response `200`

The request has succeeded.

- IntegrationMetadata — Integration metadata
  - `additional_id_1` string
  - `connected_advertiser_id` string
  - `connected_lba_id` string
  - `connected_merchant_id` string
  - `connected_tag_id` string
  - `connected_user_id` string
  - `created_timestamp` number
  - `external_business_id` string — External business ID for the integration.
  - `id` string
  - `partner_access_token_expiry` number
  - `partner_metadata` string
  - `partner_refresh_token_expiry` number
  - `scopes` string
  - `updated_timestamp` number

## Other responses

- `400` — The request could not be understood by the server due to unexpected data.
- `401` — Authentication is required and has either failed or not been provided.
- `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404` — The requested resource could not be found on this server.
- `429` — The user has sent too many requests in a given amount of time and is being rate limited.
- `default` — An unexpected error response.

## Changes

- **2026-06-04** (v5) `b698c180678a` — 1 breaking, 11 info
  - the `id` response's property type/format changed from `string`/`` to ``/`` for status `200`
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - …8 more
- **2025-12-11** (v5) `79f62f71f05b` — 1 breaking
  - request body became required
- **2023-05-12** (v5) `689b4b267639` — 14 info
  - added the new optional request property `additional_id_1`
  - added the new optional request property `partner_access_token_expiry`
  - added the new optional request property `partner_metadata`
  - added the new optional request property `partner_refresh_token`
  - …10 more
- **2023-02-14** (v5) `be19b77aa78a` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/integrations/commerce/:external_business_id/patch.md)

---

[API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/b698c180678a/schema)