PIpinterest
audience_sharing

Update audience sharing from a business to ad accounts

Changed on

From a business, share a specific audience with other ad account(s), or revoke access to a previously shared audience.

  • If the business is the owner of the audience, it can share with any ad account within the same business hierarchy.
  • If the business is the recipient of the audience, it can share with any of its owned ad accounts.

This endpoint is not available to all apps. Learn more.

patch/businesses/{business_id}/audiences/ad_accounts/shared

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

Request body

audience_idstring required
operation_type'SHARE' | 'REVOKE' required

Operation type to share a specific audience or revoke access to a previously shared audience

recipient_account_idsPinterestLibIntegerFormatType[] required

Ad account IDs to share with or revoke from (request) / that received the audience (response).

Response

The request has succeeded.

audience_idstring required
permissionsRole[]

Permissions granted to the recipients.

recipient_account_idsPinterestLibIntegerFormatType[] required

Ad account IDs to share with or revoke from (request) / that received the audience (response).

Example response

{
  "permissions": [
    "RESOURCE_PINNER_LIST_READER",
    "RESOURCE_PINNER_LIST_OWNER"
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • warning

      removed subschema #2: SharedAudience from the request body allOf list

    • info

      removed subschema #2: SharedAudienceResponse from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • v510f9eba4ad97Revision changes
    • warning

      added the new CATALOGS_VIEWER enum value to the ///// response property for the response status

    • warning

      added the new FINANCE_EDIT enum value to the ///// response property for the response status

    • warning

      added the new FINANCE_VIEW enum value to the ///// response property for the response status