business_access_invite

Create a RMN partnership invite

Changed on

This endpoint is currently in beta and not available to all apps. Learn more.

Creates a RMN partnership invite from an RMN to a potential Brand. Currently, invites from Brands to RMNs are not supported.

post/businesses/{business_id}/rmn/partners/{partner_id}/invite

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

A user id that belongs to a potential partner that is not a system user.

Request body

Example request

{
  "rmn_invite_details": {
    "asset_id_to_permissions": [
      {
        "asset_type": "PINNER_LIST",
        "asset_id": "2542622182994"
      },
      {
        "asset_type": "CONVERSION_SEGMENT",
        "asset_id": "549755885175",
        "permissions": [
          "BIZ_CONVERSION_SEGMENT_SHARER"
        ]
      },
      {
        "asset_type": "CATALOG",
        "asset_id": "549755885176"
      }
    ],
    "domain_restrictions": [
      "example.com"
    ]
  }
}

Response

The request has succeeded.

business_idstring required

Changes