--- title: "Create a product campaign" method: POST path: "/v3/product-campaigns" tags: ["productCampaign"] --- # Create a product campaign `POST /v3/product-campaigns` This endpoint creates a new product campaign with the marketing settings and product selections. Set up campaign details like budget, duration, and which products to promote. The campaign will be ready to launch once created. The following fields inside productCampaign are required: name, namespaceId, campaignState, teamId, walletId, placementId, catalogIds (at least one), and strategy (either strategy.auction or strategy.fixedTenancy). For search-targeted placements, targeting.searchTerms is also required, and each entry must include phrase and matchType. The caller's user must have the ROLE_CAMPAIGN_EDITOR permission on the campaign's teamId (or be an admin); otherwise the request will be rejected with PERMISSION_DENIED. ## Request body - Campaignv3CreateProductCampaignRequest - `productCampaign` Campaignv3ProductCampaign, required - `id` string — The unique identifier of the campaign. Server-generated on create; required when updating. - `updateTime` string, date-time — The last time the entity was updated as a precise ISO-8601 timestamp. - `name` string, required — The name of the campaign. Required when creating a campaign. - `namespaceId` string, required — The unique identifier of the namespace. Required when creating a campaign. - `approval` Campaignv3Approval - `state` 'APPROVAL_STATE_PENDING' | 'APPROVAL_STATE_APPROVED' | 'APPROVAL_STATE_REJECTED' - `rejectionReason` string — The reason a campaign has been rejected. Mandatory field if status is APPROVAL_STATE_REJECTED - `campaignState` 'CAMPAIGN_STATE_UNSPECIFIED' | 'CAMPAIGN_STATE_ACTIVE' | 'CAMPAIGN_STATE_PAUSED' | 'CAMPAIGN_STATE_DRAFT' | 'CAMPAIGN_STATE_ARCHIVED', required - `templateId` string — The unique identifier of the campaign template. - `managerTeamId` string — The retailer manager's team ID for the campaign. It applies only to fixed tenancy campaigns. - `teamId` string, required — The unique identifier of the campaign's team. Required when creating a campaign. The caller must have ROLE_CAMPAIGN_EDITOR permission on this team (or admin role). - `startTime` string, date-time — When the campaign starts as a precise ISO-8601 timestamp. - `endTime` string, date-time — When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'. - `walletId` string, required — The unique identifier of the wallet to be charged for the campaign. Required when creating a campaign. - `placementId` string, required — The unique identifier of the campaign's placement. Required when creating a campaign and cannot be changed afterwards. - `catalogIds` string[], required — The unique identifier of the retailer's catalog. At least one catalog ID is required when creating a campaign. - `advertisedProducts` Campaignv3AdvertisedProducts - `productsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `productGroupList` string[] — The list of product group ids from Epsilon Digital - `targeting` Campaignv3Targeting - `searchTerms` Campaignv3SearchTerm[] — Used for placements that target search terms. - `phrase` string — The keyword you want to target in your campaign, with a maximum length of 150 characters. - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_PHRASE_MATCH' | 'MATCH_TYPE_EXACT_MATCH' - `collectionName` string — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `suggested` boolean — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `excludedProducts` Campaignv3CatalogProductSeller[] — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `maxBid` string — The maximum cost per click bid for the search term, overriding the auction's default max bid for that term. - `treatAsCustom` boolean — Flag that determines whether the search term is treated as custom. Custom terms apply to all products in the campaign. This flag should only be used when the placement supports suggested search terms and allows custom terms. - `crossSell` Campaignv3CrossSell - `targetProductsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `upsell` Campaignv3Upsell - `targetProductsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `excludeFilters` Campaignv3TargetedFilter[] — Used for integrations, excluding those with the filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `includeFilters` Campaignv3TargetedFilter[] — Used for integrations, including those with the filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `negativeSearchTerms` V3NegativeSearchTerm[] — Used for placements that target search terms. - `phrase` string — The negative search term. - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_EXACT_MATCH' | 'MATCH_TYPE_PHRASE_MATCH' - `audience` V3Audience - `includeSegmentsSets` V3SegmentsSet[] — Segment sets used for audience targeting combined by AND operator. - `segmentIds` string[] — Segments used for audience targeting combined by OR operator. - `strategy` Campaignv3Strategy, required - `auction` Campaignv3Auction - `maxBid` string — The maximum cost per click for the campaign. For search targeted placements, any search term max bid defined against a search term will override the auction max bid. - `spendLimit` Campaignv3SpendLimit - `daily` string — Daily spend limit. - `total` string — Total spend limit. - `fixedTenancy` Campaignv3FixedTenancy - `cost` string — The cost of the campaign for reporting purposes. This value is not charged to the wallet. - `positions` integer[] — The fixed tenancy position booked by the campaign. - `catalogCosts` Campaignv3CatalogCost[] - `catalogId` string — The unique identifier of the retailer's catalog. - `catalogCostPercentage` number, float — The percentage of the campaign's cost allocated to the catalog. - `fixedCosts` Campaignv3FixedCosts - `dataCost` string — The cost associated with data for the campaign. - `creativeCost` string — The cost associated with creative production for the campaign. - `otherCost` string — The cost associated with other expenses for the campaign. - `customFields` Campaignv3CustomField[] - `customFieldId` string — The unique identifier of the custom field. - `content` string — The contents of the custom field. - `customQuestions` Campaignv3CustomQuestion[] — The integration for campaigns utilizing custom targeting. - `customQuestionId` string — The ID of the custom question. - `answers` string[] — The selections of the advertiser relevant to the custom question. - `sellerId` string — The seller ID of the campaign. Defaults to an empty string if null. ## Response `200` Details of the created campaign. - Campaignv3CreateProductCampaignResponse - `productCampaign` Campaignv3ProductCampaign, required - `id` string — The unique identifier of the campaign. Server-generated on create; required when updating. - `updateTime` string, date-time — The last time the entity was updated as a precise ISO-8601 timestamp. - `name` string, required — The name of the campaign. Required when creating a campaign. - `namespaceId` string, required — The unique identifier of the namespace. Required when creating a campaign. - `approval` Campaignv3Approval - `state` 'APPROVAL_STATE_PENDING' | 'APPROVAL_STATE_APPROVED' | 'APPROVAL_STATE_REJECTED' - `rejectionReason` string — The reason a campaign has been rejected. Mandatory field if status is APPROVAL_STATE_REJECTED - `campaignState` 'CAMPAIGN_STATE_UNSPECIFIED' | 'CAMPAIGN_STATE_ACTIVE' | 'CAMPAIGN_STATE_PAUSED' | 'CAMPAIGN_STATE_DRAFT' | 'CAMPAIGN_STATE_ARCHIVED', required - `templateId` string — The unique identifier of the campaign template. - `managerTeamId` string — The retailer manager's team ID for the campaign. It applies only to fixed tenancy campaigns. - `teamId` string, required — The unique identifier of the campaign's team. Required when creating a campaign. The caller must have ROLE_CAMPAIGN_EDITOR permission on this team (or admin role). - `startTime` string, date-time — When the campaign starts as a precise ISO-8601 timestamp. - `endTime` string, date-time — When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'. - `walletId` string, required — The unique identifier of the wallet to be charged for the campaign. Required when creating a campaign. - `placementId` string, required — The unique identifier of the campaign's placement. Required when creating a campaign and cannot be changed afterwards. - `catalogIds` string[], required — The unique identifier of the retailer's catalog. At least one catalog ID is required when creating a campaign. - `advertisedProducts` Campaignv3AdvertisedProducts - `productsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `productGroupList` string[] — The list of product group ids from Epsilon Digital - `targeting` Campaignv3Targeting - `searchTerms` Campaignv3SearchTerm[] — Used for placements that target search terms. - `phrase` string — The keyword you want to target in your campaign, with a maximum length of 150 characters. - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_PHRASE_MATCH' | 'MATCH_TYPE_EXACT_MATCH' - `collectionName` string — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `suggested` boolean — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `excludedProducts` Campaignv3CatalogProductSeller[] — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `maxBid` string — The maximum cost per click bid for the search term, overriding the auction's default max bid for that term. - `treatAsCustom` boolean — Flag that determines whether the search term is treated as custom. Custom terms apply to all products in the campaign. This flag should only be used when the placement supports suggested search terms and allows custom terms. - `crossSell` Campaignv3CrossSell - `targetProductsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `upsell` Campaignv3Upsell - `targetProductsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `excludeFilters` Campaignv3TargetedFilter[] — Used for integrations, excluding those with the filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `includeFilters` Campaignv3TargetedFilter[] — Used for integrations, including those with the filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `negativeSearchTerms` V3NegativeSearchTerm[] — Used for placements that target search terms. - `phrase` string — The negative search term. - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_EXACT_MATCH' | 'MATCH_TYPE_PHRASE_MATCH' - `audience` V3Audience - `includeSegmentsSets` V3SegmentsSet[] — Segment sets used for audience targeting combined by AND operator. - `segmentIds` string[] — Segments used for audience targeting combined by OR operator. - `strategy` Campaignv3Strategy, required - `auction` Campaignv3Auction - `maxBid` string — The maximum cost per click for the campaign. For search targeted placements, any search term max bid defined against a search term will override the auction max bid. - `spendLimit` Campaignv3SpendLimit - `daily` string — Daily spend limit. - `total` string — Total spend limit. - `fixedTenancy` Campaignv3FixedTenancy - `cost` string — The cost of the campaign for reporting purposes. This value is not charged to the wallet. - `positions` integer[] — The fixed tenancy position booked by the campaign. - `catalogCosts` Campaignv3CatalogCost[] - `catalogId` string — The unique identifier of the retailer's catalog. - `catalogCostPercentage` number, float — The percentage of the campaign's cost allocated to the catalog. - `fixedCosts` Campaignv3FixedCosts - `dataCost` string — The cost associated with data for the campaign. - `creativeCost` string — The cost associated with creative production for the campaign. - `otherCost` string — The cost associated with other expenses for the campaign. - `customFields` Campaignv3CustomField[] - `customFieldId` string — The unique identifier of the custom field. - `content` string — The contents of the custom field. - `customQuestions` Campaignv3CustomQuestion[] — The integration for campaigns utilizing custom targeting. - `customQuestionId` string — The ID of the custom question. - `answers` string[] — The selections of the advertiser relevant to the custom question. - `sellerId` string — The seller ID of the campaign. Defaults to an empty string if null. ## Other responses - `400` — There was a problem with input. - `401` — Login failed or token not valid. - `403` — Access denied due to insufficient permissions. - `default` — An unexpected error response. --- [API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/revisions/a040003c7378/schema)