--- title: "Get campaign audience configuration" method: GET path: "/api/rnb/pvt/campaignConfiguration/{campaignId}" tags: ["Campaign Audiences"] --- # Get campaign audience configuration `GET /api/rnb/pvt/campaignConfiguration/{campaignId}` Retrieves a specific campaign audience configuration by its ID. This API uses the campaign ID, not the campaign name. ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | Rates and Benefits | Manage benefits and rates | **GerenciarPromocoesETarifas** | There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations. ## Path parameters - `campaignId` string, required ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - object - `beginDateUtc` string — Start date of the campaign audience in UTC format. - `endDateUtc` string — End date of the campaign audience in UTC format. - `id` string — Campaign audience ID. - `name` string — Campaign audience name. - `isActive` boolean — Defines if the campaign audience is active (`true`) or not (`false`). - `isAndOperator` boolean — When `true`, determines that all the `targetConfigurations` need to be valid for the campaign audience to be active. When `false`, determines that if at least one of the `targetConfigurations` is valid, the campaign audience will be active. - `isArchived` boolean — Defines if the campaign audience is archived (`true`) or not (`false`). - `lastModified` object — Object with information about the most recent update of the campaign audience. - `dateUtc` string — Date of the most recent update in UTC format. - `user` string — Email of the user who updated the campaign audience for the latest time. - `targetConfigurations` object[] — Array that contains all target audience that the campaign audience will be valid. - `featured` boolean — Defines if the target audience is featured (`true`) or not (`false`). - `id` string — Target audience ID. - `name` string — Target audience name. - `daysAgoOfPurchases` integer — Number of days that are considered to add the purchase history. - `origin` string — Shows the campaign audience origin, `Marketplace` or `Fulfillment`. Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information. - `idSellerIsInclusive` boolean — Defines if at least one of the sellers must be valid to active the campaign audience. - `idsSalesChannel` string[] — Array with all the trade policies that activate the campaign audience. - `areSalesChannelIdsExclusive` boolean — Defines if the trade policy IDs are exclusive. - `marketingTags` string[] — Array with all the campaign audience's marketing tags. - `marketingTagsAreNotInclusive` boolean — Defines if marketing tags are not inclusive. - `paymentsMethods` object[] — Array composed by all the Payments Methods. - `id` string — Payment Method ID. - `name` string — Payment Method Name. - `stores` string[] — List of stores. - `campaigns` string[] — Campaign Audiences that activate this promotion. - `storesAreInclusive` boolean — If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied. - `categories` object[] — Object composed by the categories that will activate or deactivate the campaign audience. - `id` string — Category ID. - `name` string — Category Name. - `categoriesAreInclusive` boolean — If set to `true`, this campaign audience will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this campaign audience not to be applied. - `brands` object[] — Object composed by the brands that will activate or deactivate the campaign audience. - `id` string — Brand ID. - `name` string — Brand Name. - `brandsAreInclusive` boolean — If set to `true`, this campaign audience will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this campaign audience not to be applied. - `products` object[] — Object composed by the products that will activate or deactivate the campaign audience. - `id` string — Product ID. - `name` string — Product Name. - `productsAreInclusive` boolean — If set to `true`, this campaign audience will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this campaign audience not to be applied. - `skus` object[] — Object composed by the SKUs that will activate or deactivate the campaign audience. - `id` string — SKU ID. - `name` string — SKU Name. - `skusAreInclusive` boolean — If set to `true`, this campaign audience will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this campaign audience not to be applied. - `collections1BuyTogether` object[] — Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**. - `id` string — ID of the collection to be added to the first list of the **Buy Together** promotion. - `name` string — Name of the collection to be added to the first list of the **Buy Together** promotion. - `collections2BuyTogether` object[] — Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**. - `id` string — ID of the collection to be added to the first list of the **Buy Together** promotion. - `name` string — Name of the collection to be added to the first list of the **Buy Together** promotion. - `minimumQuantityBuyTogether` integer — Minimum quantity for **Buy Together** promotion. - `quantityToAffectBuyTogether` integer — Quantity to affect **Buy Together** promotion. - `enableBuyTogetherPerSku` boolean — Enable **Buy Together** per SKU. - `listSku1BuyTogether` object[] — Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation. - `id` string — ID of the SKU to be added to the first list of the **Buy Together** promotion. - `name` string — Name of the SKU to be added to the first list of the **Buy Together** promotion. - `listSku2BuyTogether` object[] — Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation. - `id` string — ID of the SKU to be added to the second list of the **Buy Together** promotion. - `name` string — Name of the SKU to be added to the second list of the **Buy Together** promotion. - `listBrand1BuyTogether` object[] — Array of objects, each containing ID and Name of a brand to be added in the first list of the **Buy Together** promotion. - `id` string — ID of the brand to be added to the first list of the **Buy Together** promotion. - `name` string — Name of the brand to be added to the first list of the **Buy Together** promotion. - `listCategory1BuyTogether` object[] — Array of objects, each containing ID and Name of a category to be added in the first list of the **Buy Together** promotion. - `id` string — ID of the category to be added to the first list of the **Buy Together** promotion. - `name` string — Name of the category to be added to the first list of the **Buy Together** promotion. - `coupon` string[] — List of coupons. - `totalValueFloor` number — Minimum chart value to active the campaign audience. - `totalValueCeling` number — Maximum chart value to active the campaign audience. - `totalValueIncludeAllItems` boolean — Total value including all items. - `totalValueMode` string — Total chart value to active the campaign audience. - `collections` object[] — Object composed by the collections that will activate or deactivate the campaign audience. - `id` string — Collection ID. - `name` string — Collection Name. - `collectionsIsInclusive` boolean — If set to `true`, this campaign audience will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this campaign audience not to be applied. - `restrictionsBins` string[] — The discount will be granted if the card's BIN is given. - `cardIssuers` string[] — List of card issuers. - `totalValuePurchase` number — Total value a client must have in past orders to active the campaign audience. - `slasIds` string[] — The discount will be granted if the shipping method is the same as the one given. - `isSlaSelected` boolean — Applies selected discount only when one of the defined shipping method is selected by the customer. - `isFirstBuy` boolean — Applies the discount only if it's a first buy. - `firstBuyIsProfileOptimistic` boolean — Applies the discount even if the user is not logged. - `compareListPriceAndPrice` boolean — If the **List Price** and **Price** are the same. - `isDifferentListPriceAndPrice` boolean — Applies the campaign audience only if the list price and price is different. - `zipCodeRanges` object[] — Range of zip codes that applies the promotion. - `zipCodeFrom` string — Initial Zip Code. - `zipCodeTo` string — Final Zip Code. - `inclusive` boolean — Defines if the zip code range is included in the promotion. - `itemMaxPrice` number — Maximum price of the item. - `itemMinPrice` number — Minimum price of the item. - `installment` integer — Installment. - `isMinMaxInstallments` boolean — Set if the campaign audience will be applied considering a minimum and maximum values for installments. - `minInstallment` integer — Minimum value for installment. - `maxInstallment` integer — Maximum value for installment. - `merchants` string[] — List of merchants. - `clusterExpressions` string[] — Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field). - `paymentsRules` string[] — List of payment rules. - `giftListTypes` string[] — Gifts List Type. - `productsSpecifications` string[] — List of product specifications. - `affiliates` object[] — Marketplace order identifier. The discount will apply to selected affiliates. - `id` string — Affiliate ID. - `name` string — Affiliate Name. - `maxUsage` integer — Defines how many times the campaign audience can be used. - `maxUsagePerClient` integer — Defines if the campaign audience can be used multiple times per client. - `shouldDistributeDiscountAmongMatchedItems` boolean — Should distribute discount among matched items. - `multipleUsePerClient` boolean — Defines if the campaign audience can be used multiple times per client. - `useNewProgressiveAlgorithm` boolean — Use new progressive algorithm. - `percentualDiscountValueList` number[] — Percentual discount value list. --- [API](https://skmtc.net/vtex/apis/promotions-taxes-api.md) · [All operations](https://skmtc.net/vtex/apis/promotions-taxes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/promotions-taxes-api/revisions/6ad1b4bbb46f/schema)