business_access_invite

Create AOAA request

Changed on

Create a request for an Agency Owned Ad Account (AOAA).

post/businesses/{business_id}/partners/{partner_id}/ad_account_request

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
    Scopesbiz_access:write

Path parameters

business_idstring required

Unique identifier of the requesting business.

partner_idstring required

The partner id to be bound to the Business

Request body

namestring required

Ad account name.

countrystring required

Ad account country.

currency'UNK' | 'USD' | 'GBP' | 'CAD' | 'EUR' | 'AUD' | 'NZD' | 'SEK' | 'ILS' | 'CHF' | 'HKD' | 'JPY' | 'SGD' | 'KRW' | 'NOK' | 'DKK' | 'PLN' | 'RON' | 'HUF' | 'CZK' | 'BRL' | 'MXN' | 'ARS' | 'CLP' | 'COP' | 'INR' | 'TRY'

Currency Codes from ISO 4217

business_id_to_permissionsobject required

Business id to permissions mapping.

Example request

{
  "name": "Ad account 1",
  "country": "US",
  "business_id_to_permissions": {
    "business_1": [
      "ANALYST"
    ],
    "business_2": [
      "FINANCE_MANAGER",
      "ANALYST"
    ]
  }
}

Response

The request has succeeded.

business_idstring required
dataobject required

Partner id to created request id mapping.

Example response

{
  "data": {
    "partner_1": "9367193228913481"
  }
}

Changes