v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB
audience_sharing

Update audience sharing between businesses

From a business, share a specific audience with another business account, or revoke access to a previously shared audience. Only the audience owner can share the audience with other businesses, and the recipient business must be within the same business hierarchy.

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

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

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_business_idsPinterestLibIntegerFormatType[] required

Business 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_business_idsPinterestLibIntegerFormatType[] required

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

Example response

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