--- title: "Create product group" method: POST path: "/catalogs/product_groups" tags: ["catalog_product_groups"] --- # Create product group `POST /catalogs/product_groups` Create product group to use in Catalogs 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](/docs/api/v5/#operation/ad_accounts/list)) 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](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager. "Catalog-based product groups" can include items from all data sources (feeds and API) and are available to both non-retail catalogs with any data sources and retail catalogs with API-created items. If your catalog only contains retail items created via feeds, you should use the "retail feed-based" option. [Learn more](/docs/api-features/shopping-overview/) Note: Access to the Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager. ## Query parameters - `ad_account_id` string ## Request body - union - CatalogsProductGroupCreateRequest — Request object for creating a product group. - `description` string, nullable - `feed_id` string, required — Catalog Feed id pertaining to the catalog product group. - `filters` union, required — Object holding a group of filters for request on catalog product group. This is a distinct schema. It is not possible to create or update a Product Group with empty filters. But some automatically generated Product Groups might have empty filters. - CatalogsProductGroupFiltersRequestAnyOfItems0 - `any_of` CatalogsProductGroupFilterKeys[], required - union - union — Base filter keys shared across catalog filtering - … - ProductGroupReferenceFilter - … - CatalogsProductGroupFiltersRequestAnyOfItems1 - `all_of` CatalogsProductGroupFilterKeys[], required - union - union — Base filter keys shared across catalog filtering - … - ProductGroupReferenceFilter - … - `is_featured` boolean — boolean indicator of whether the product group is being featured or not - `name` string, required - union — Request object for creating a catalog based product group. - object — Request object for creating a product group. - `catalog_id` string, required - `catalog_type` 'RETAIL', required — Retail catalog based product group is available only for selected partners at the moment. If you are not eligible, please use feed based one. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — Country ID from ISO 3166-1 alpha-2. - `description` string, nullable - `filters` union, required — Object holding a group of filters for request on catalog product group. This is a distinct schema. It is not possible to create or update a Product Group with empty filters. But some automatically generated Product Groups might have empty filters. - CatalogsProductGroupFiltersRequestAnyOfItems0 - `any_of` CatalogsProductGroupFilterKeys[], required - union - … - CatalogsProductGroupFiltersRequestAnyOfItems1 - `all_of` CatalogsProductGroupFilterKeys[], required - union - … - `locale` 'af-ZA' | 'ar-SA' | 'bg-BG' | 'bn-IN' | 'cs-CZ' | 'da-DK' | 'de' | 'el-GR' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IN' | 'en-US' | 'es-419' | 'es-AR' | 'es-ES' | 'es-MX' | 'fi-FI' | 'fr' | 'fr-CA' | 'he-IL' | 'hi-IN' | 'hr-HR' | 'hu-HU' | 'id-ID' | 'it' | 'ja' | 'ko-KR' | 'ms-MY' | 'nb-NO' | 'nl' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'sk-SK' | 'sv-SE' | 'te-IN' | 'th-TH' | 'tl-PH' | 'tr' | 'uk-UA' | 'vi-VN' | 'zh-CN' | 'zh-TW' - `name` string, required - object — Request object for creating a hotel product group. - `catalog_id` string, required - `catalog_type` 'HOTEL', required - `description` string, nullable - `filters` union, required — Object holding a group of filters for a hotel product group - CatalogsHotelProductGroupFiltersAnyOf - `any_of` CatalogsHotelProductGroupFilterKeys[], required - union - … - CatalogsHotelProductGroupFiltersAllOf - `all_of` CatalogsHotelProductGroupFilterKeys[], required - union - … - `name` string, required - object — Request object for creating a creative assets product group. - `catalog_id` string, required - `catalog_type` 'CREATIVE_ASSETS', required - `description` string, nullable - `filters` union, required — Object holding a group of filters for a creative assets product group - CatalogsCreativeAssetsProductGroupFiltersAnyOf - `any_of` CatalogsCreativeAssetsProductGroupFilterKeys[], required - union - … - CatalogsCreativeAssetsProductGroupFiltersAllOf - `all_of` CatalogsCreativeAssetsProductGroupFilterKeys[], required - union - … - `name` string, required ## Response `200` The request has succeeded. - union - object - `catalog_id` string, required - `catalog_type` 'RETAIL', required - `country` string, nullable - `created_at` integer — Unix timestamp in seconds of when catalog product group was created. - `description` string, nullable - `feed_id` string, nullable, required — id of the catalogs feed belonging to this catalog product group - `filters` union, required — Object holding a group of filters for a catalog product group - CatalogsProductGroupFiltersAnyOf - `any_of` CatalogsProductGroupFilterKeys[], required - union - union — Base filter keys shared across catalog filtering - … - ProductGroupReferenceFilter - … - CatalogsProductGroupFiltersAllOf - `all_of` CatalogsProductGroupFilterKeys[], required - union - union — Base filter keys shared across catalog filtering - … - ProductGroupReferenceFilter - … - `id` string, required - `is_featured` boolean — boolean indicator of whether the product group is being featured or not - `locale` string, nullable - `name` string — Name of catalog product group - `status` 'ACTIVE' | 'INACTIVE' - `type` 'MERCHANT_CREATED' | 'ALL_PRODUCTS' | 'BEST_DEALS' | 'PINNER_FAVORITES' | 'TOP_SELLERS' | 'BACK_IN_STOCK' | 'NEW_ARRIVALS' | 'SHOPIFY_COLLECTIONS' | 'I2PC' | 'CATALOG_EXPANSION', required — Catalog product group type - **MERCHANT_CREATED**: Product groups created by merchants. - **ALL_PRODUCTS**: Consists of every product in your latest successful feed upload. - **BEST_DEALS**: Consists of products with the deepest drop in price. - **PINNER_FAVORITES**: Consists of products that are resonating most with people on Pinterest, based on engagement. - **TOP_SELLERS**: Consists of products with the highest conversion rate, if you have the conversion tag installed. - **BACK_IN_STOCK**: Consists of products that were previously out of stock and are now in stock. - **NEW_ARRIVALS**: Consists of products that are new to your Catalog. - **SHOPIFY_COLLECTIONS**: Product groups created based on Shopify Product Collections. - **I2PC**: Product groups created based on predicted product category. - **CATALOG_EXPANSION**: Consists of high-potential, recommended products from your catalog. - `updated_at` integer — Unix timestamp in seconds of last time catalog product group was updated. - object - `catalog_id` string, required - `catalog_type` 'HOTEL', required - `created_at` integer — Unix timestamp in seconds of when catalog product group was created. - `description` string, nullable - `filters` union, required — Object holding a group of filters for a hotel product group - CatalogsHotelProductGroupFiltersAnyOf - `any_of` CatalogsHotelProductGroupFilterKeys[], required - union - PriceFilter - … - HotelIdFilter - … - BrandFilter - … - CustomLabel0Filter - … - CustomLabel1Filter - … - CustomLabel2Filter - … - CustomLabel3Filter - … - CustomLabel4Filter - … - CountryFilter - … - TitleKeywordsFilter - … - CatalogsHotelProductGroupFiltersAllOf - `all_of` CatalogsHotelProductGroupFilterKeys[], required - union - PriceFilter - … - HotelIdFilter - … - BrandFilter - … - CustomLabel0Filter - … - CustomLabel1Filter - … - CustomLabel2Filter - … - CustomLabel3Filter - … - CustomLabel4Filter - … - CountryFilter - … - TitleKeywordsFilter - … - `id` string, required - `name` string — Name of catalog product group - `type` 'MERCHANT_CREATED' | 'ALL_LISTINGS', required — Catalog hotel product group type - `updated_at` integer — Unix timestamp in seconds of last time catalog product group was updated. - object - `catalog_id` string, required - `catalog_type` 'CREATIVE_ASSETS', required - `created_at` integer — Unix timestamp in seconds of when catalog product group was created. - `description` string, nullable - `filters` union, required — Object holding a group of filters for a creative assets product group - CatalogsCreativeAssetsProductGroupFiltersAnyOf - `any_of` CatalogsCreativeAssetsProductGroupFilterKeys[], required - union - CreativeAssetsIdFilter - … - CustomLabel0Filter - … - CustomLabel1Filter - … - CustomLabel2Filter - … - CustomLabel3Filter - … - CustomLabel4Filter - … - GoogleProductCategory6Filter - … - GoogleProductCategory5Filter - … - GoogleProductCategory4Filter - … - GoogleProductCategory3Filter - … - GoogleProductCategory2Filter - … - GoogleProductCategory1Filter - … - GoogleProductCategory0Filter - … - MediaTypeFilter - … - TitleKeywordsFilter - … - LinkFilter - … - CatalogsCreativeAssetsProductGroupFiltersAllOf - `all_of` CatalogsCreativeAssetsProductGroupFilterKeys[], required - union - CreativeAssetsIdFilter - … - CustomLabel0Filter - … - CustomLabel1Filter - … - CustomLabel2Filter - … - CustomLabel3Filter - … - CustomLabel4Filter - … - GoogleProductCategory6Filter - … - GoogleProductCategory5Filter - … - GoogleProductCategory4Filter - … - GoogleProductCategory3Filter - … - GoogleProductCategory2Filter - … - GoogleProductCategory1Filter - … - GoogleProductCategory0Filter - … - MediaTypeFilter - … - TitleKeywordsFilter - … - LinkFilter - … - `id` string, required - `name` string — Name of catalog product group - `updated_at` integer — Unix timestamp in seconds of last time catalog product group was updated. ## Other responses - `201` — Resource create operation completed successfully. - `400` — The request could not be understood by the server due to unexpected data. - `401` — Authentication is required and has either failed or not been provided. - `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource. - `404` — The requested resource could not be found on this server. - `429` — The user has sent too many requests in a given amount of time and is being rate limited. - `default` — An unexpected error response. --- [API](https://skmtc.net/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.net/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/b698c180678a/schema)