ad_accounts14

ad_groups13

ads10

advanced_auction2

audience_insights2

audience_sharing7

audiences4

billing11

boards11

bulk3

business_access_assets12

business_access_invite6

business_access_relationships9

campaigns8

catalog_feeds8

catalog_items3

catalog_product_groups10

catalog_reports3

catalog_supplemental7

catalogs3

conversion_deletion_requests4

conversion_eqs1

conversion_events1

conversion_tags5

conversions4

customer_list_uploads3

customer_lists4

customer_segment3

integrations7

keywords5

labels5

lead_ads4

lead_forms5

leads_export2

media3

msot_events1

notification1

oauth3

order_lines2

pins8

product_group_promotions5

product_tags3

promotions5

resources6

schedules3

search3

targeting_template3

terms2

terms_of_service1

trends4

user_account14

audience_sharing

Update audience sharing from an ad account to businesses

Changed on Jun 4, 2026

From an ad account, share a specific audience with a business account, or revoke access to a previously shared audience. Only the audience owner account can share the audience. The recipient business account must be in the same business hierarchy as the business owner of the ad account.

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

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

Request

Base URL
https://api.pinterest.com/v5
Auth
OAuth 2
Authorization codehttps://www.pinterest.com/oauth/
Token URLhttps://api.pinterest.com/v5/oauth/token
Scopesads:write
TypeScript
https://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/ad_accounts/:ad_account_id/audiences/businesses/shared/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

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"
  ]
}

Changes

Jun 4, 2026v5b698c180678a Revision 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: BusinessSharedAudience from the request body allOf list
- info
  removed subschema #2: BusinessSharedAudienceResponse 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
Apr 4, 2025v510f9eba4ad97 Revision 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

Operation history (3 revisions)