PIpinterest
catalogs

Create catalog

Changed on

Create a new catalog owned by the "operation user_account".

  • By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.

Learn more

Note: Access to the Product and Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager.

post/catalogs

Request

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

catalog_type'RETAIL' | 'HOTEL' | 'CREATIVE_ASSETS' required

Type of the catalog entity.

namestring required

A human-friendly name associated to a catalog entity.

Response

The request has succeeded.

catalog_type'RETAIL' | 'HOTEL' | 'CREATIVE_ASSETS' required

Type of the catalog entity.

created_atstring date-time required
idstring required

ID of the catalog entity.

namestring required

A human-friendly name associated to a catalog entity.

updated_atstring date-time required

Example response

{
  "created_at": "2022-03-14T15:15:22Z",
  "id": "864344156814050986",
  "updated_at": "2022-03-14T15:16:34Z"
}

Changes

  • v5b698c180678aRevision changes
    • 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 required 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the success response with the status

  • v58fb7ab040159Revision changes
    • info

      added the new RETAIL enum value to the request property