Sign in
integrations

Update commerce integration

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.

patch/integrations/commerce/{external_business_id}

Path parameters

external_business_idstring required

External business ID for the integration.

Request body

additional_id_1string
connected_advertiser_idstring
connected_lba_idstring
connected_merchant_idstring
connected_tag_idstring
partner_access_tokenstring
partner_access_token_expirynumber
partner_metadatastring
partner_primary_emailstring
partner_refresh_tokenstring
partner_refresh_token_expirynumber
scopesstring

Response

The request has succeeded.

additional_id_1string
connected_advertiser_idstring
connected_lba_idstring
connected_merchant_idstring
connected_tag_idstring
connected_user_idstring
created_timestampnumber
external_business_idstring

External business ID for the integration.

idstring
partner_access_token_expirynumber
partner_metadatastring
partner_refresh_token_expirynumber
scopesstring
updated_timestampnumber

Example response

{
  "id": "7329167449607351372",
  "external_business_id": "1238401984",
  "connected_merchant_id": "1445572885401",
  "connected_user_id": "871939315263957401",
  "connected_advertiser_id": "549764738871",
  "connected_lba_id": "871939315263957402",
  "connected_tag_id": "2412141155151",
  "partner_access_token_expiry": 1621350033000,
  "partner_refresh_token_expiry": 1621350033000,
  "scopes": "accounts:read",
  "created_timestamp": 1621350033000,
  "updated_timestamp": 1621350033000,
  "additional_id_1": "128464",
  "partner_metadata": ""
}

Changes

Changed in 4 of the 29 revisions of this API.226

  • v5b698c180678a111See the full diff
    • ▲

      the id response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      removed the non-success response with the status 409

      response-non-success-status-removed

    • ○

      the response optional property connected_advertiser_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property created_timestamp became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response optional property id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response optional property updated_timestamp became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      added Pinterest.Lib.IntegerFormatType to the id response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      the id response's property pattern ^\d+$ was removed for the status 200

      response-property-pattern-removed

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v579f62f71f05b1See the full diff
    • ▲

      request body became required

      request-body-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5689b4b26763914See the full diff
    • ○

      added the new optional request property additional_id_1

      new-optional-request-property

    • ○

      added the new optional request property partner_access_token_expiry

      new-optional-request-property

    • ○

      added the new optional request property partner_metadata

      new-optional-request-property

    • ○

      added the new optional request property partner_refresh_token

      new-optional-request-property

    • ○

      added the new optional request property partner_refresh_token_expiry

      new-optional-request-property

    • ○

      added the new optional request property scopes

      new-optional-request-property

    • ○

      added the optional property additional_id_1 to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property created_timestamp to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property partner_access_token_expiry to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property partner_metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property partner_refresh_token_expiry to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property scopes to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property updated_timestamp to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5be19b77aa78a1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog