catalogs

Create catalog

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 <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) 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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access</a> roles on the ad_account: Owner, Admin, Catalogs Manager.

<a href='/docs/api-features/shopping-overview/'>Learn more</a>

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

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 given catalog.

Response

Success

created_atstring date-time required
idstring required

ID of the catalog entity.

updated_atstring date-time required
namestring nullable required

A human-friendly name associated to a catalog entity.

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

Type of the catalog entity.

Example response

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

Changes