PIpinterest
promotions

Get promotions

Changed on

Gets all promotions associated with an ad account ID that can be applied to an ad group. Can be either internally-saved promotions or external promotions imported from a commerce integration.

get/ad_accounts/{ad_account_id}/promotions

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

order'ASCENDING' | 'DESCENDING'

The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "promotion_type": "VARIABLE",
      "status": "ACTIVE",
      "template_values": [
        {
          "amount": 100,
          "custom_text": "My promotion",
          "percent": 10
        }
      ]
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      for the query request parameter order, default value ASCENDING was added

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 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

  • v58fb7ab040159Revision changes
    • warning

      added the new CUSTOM enum value to the //// response property for the response status

    • info

      added the optional property ////// to the response with the status