business_access_invite

Get AOAA requests

Changed on

Get Agency Owned Ad Account (AOAA) requests.

get/businesses/{business_id}/ad_account_requests

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:read

Path parameters

business_idstring required

Unique identifier of the requesting business.

Query parameters

partner_idstring

Partner business id.

request_idsPinterestLibIntegerFormatType[]

A list of agency owned ad account request ids.

statusesAgencyOwnedAdAccountRequestStatus[]

A list of agency owned ad account request statuses.

[
  "PENDING"
]
request_direction'SENT' | 'RECEIVED' | 'ALL'

AOAA request direction.

Example:ALL

The direction of the request.

Response

The request has succeeded.

request_idstring required
namestring required

Requested 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

status'PENDING' | 'ACCEPTED' | 'DECLINED' | 'CANCELED' | 'EXPIRED' required

AOAA request status.

permissionsobject[]

Permissions grouped by business user id.

Example response

[
  {
    "name": "Ad Account 1",
    "country": "US",
    "status": "PENDING",
    "owner_business": {
      "full_name": "Carp Media Agency",
      "username": "carpmedia",
      "image_medium_url": "https://s.pinimg.com/images/user/image.png",
      "image_small_url": "https://s.pinimg.com/images/user/image.png"
    },
    "client_business": {
      "full_name": "Carp Media Agency",
      "username": "carpmedia",
      "image_medium_url": "https://s.pinimg.com/images/user/image.png",
      "image_small_url": "https://s.pinimg.com/images/user/image.png"
    }
  }
]

Changes