---
title: "Update banner X campaign approval state"
method: POST
path: "/v3/bannerx-campaigns/{id}:approve"
tags: ["bannerXCampaign"]
---

# Update banner X campaign approval state

`POST /v3/bannerx-campaigns/{id}:approve`

Updates the approval state of a specified banner X campaign. You can approve or reject the campaign by setting the appropriate state and providing a rejection reason if necessary.

## Path parameters

- `id` string, required

## Request body

- CampaignServiceApproveBannerXCampaignBody
  - `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

## Response `200`

The campaign approval status has been successfully updated.

- V3ApproveBannerXCampaignResponse
  - `bannerXCampaign` V3CampaignBannerX
    - `id` string — The unique identifier of the campaign.
    - `updateTime` string, date-time — The last time the entity was updated.
    - `name` string — The name of the campaign.
    - `namespaceId` string — The unique identifier of the namespace.
    - `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'
    - `templateId` string — The unique identifier of the campaign template.
    - `managerTeamId` string — The retailer manager teamId of the campaign. Only utilised in fixed tenancy campaigns.
    - `teamId` string — The unique identifier of the campaign's team.
    - `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 — The unique identifier of the wallet to be charged for the campaign.
    - `placementId` string — The unique identifier of the campaign's placement.
    - `catalogIds` string[] — The unique identifier of the retailer's catalog.
    - `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
      - `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[] — Used for integrations utilising 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 sellerId of the campaign. Defaults to empty string if null.
    - `bannerXConfig` V3BannerXConfig
      - `contentStandardId` string — The unique identifier of the content standard.
      - `slotId` string — The unique identifier of the slot.
      - `slotType` 'BANNER_X_SLOT_TYPE_UNSPECIFIED' | 'BANNER_X_SLOT_TYPE_BANNER' | 'BANNER_X_SLOT_TYPE_SINGLE_TILE' | 'BANNER_X_SLOT_TYPE_DOUBLE_TILE'
      - `headingText` string — The heading text for the banner.
      - `bannerText` string — The main text of the banner.
      - `bannerTextColourHex` string — The color of the banner text in hex format.
      - `ctaFlag` boolean — Flag indicating if the banner has a call-to-action.
      - `ctaText` string — The call-to-action text on the banner.
      - `ctaTextAccessibility` string — The call-to-action text for accessibility purposes.
      - `ctaLink` string — The URL for the call-to-action link.
      - `backgroundColourHex` string — The background color of the banner in hex format.
      - `backgroundImageId` string — The unique identifier of the background image.
      - `backgroundImagePosition` 'BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_FILL'
      - `secondaryBackgroundImageId` string — The unique identifier for the secondary background image.
      - `secondaryBackgroundImagePosition` 'BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_FILL'
      - `heroImageId` string — The unique identifier for the hero image.
      - `heroImageAltText` string — The alternate text for the hero image.
      - `heroMode` 'BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED' | 'BANNER_X_HERO_IMAGE_MODE_BLOCK' | 'BANNER_X_HERO_IMAGE_MODE_LANDSCAPE' | 'BANNER_X_HERO_IMAGE_MODE_PORTRAIT'
      - `secondaryHeroImageId` string — The unique identifier for the secondary hero image.
      - `secondaryHeroImageAltText` string — The alt text for the secondary hero image.
      - `secondaryHeroMode` 'BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED' | 'BANNER_X_HERO_IMAGE_MODE_BLOCK' | 'BANNER_X_HERO_IMAGE_MODE_LANDSCAPE' | 'BANNER_X_HERO_IMAGE_MODE_PORTRAIT'
      - `additionalFields` V3AdditionalFields[] — BannerX AdditionalFields
        - `id` string — The unique identifier for the item.
        - `value` string — The value associated with the item.
      - `trackingTagProvider` V3TrackingTag[] — BannerX TrackingTagProvider
        - `provider` 'TRACKING_TAG_PROVIDER_UNSPECIFIED' | 'TRACKING_TAG_PROVIDER_DV' | 'TRACKING_TAG_PROVIDER_DCM_CLICK' | 'TRACKING_TAG_PROVIDER_DCM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_MOAT' | 'TRACKING_TAG_PROVIDER_IAS' | 'TRACKING_TAG_PROVIDER_GTM360' | 'TRACKING_TAG_PROVIDER_SIZMEK' | 'TRACKING_TAG_PROVIDER_ADFORM_CLICK' | 'TRACKING_TAG_PROVIDER_ADFORM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_DV_IMAGE'
        - `content` string — The content of the tracking tag.
      - `primaryVideoConfig` BannerXConfigVideoConfig
        - `fileId` string — The unique identifier for the video file. Id is generated and provided by Epsilon upload file endpoint
      - `companionProducts` Campaignv3CatalogProductSeller[] — Products to be rendered in BannerX
        - `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.
    - `settings` V3CampaignSettings
      - `campaignType` 'CAMPAIGN_TYPE_UNSPECIFIED' | 'CAMPAIGN_TYPE_DISPLAY' | 'CAMPAIGN_TYPE_BANNER' | 'CAMPAIGN_TYPE_BANNERX' | 'CAMPAIGN_TYPE_BRAND_PAGE' | 'CAMPAIGN_TYPE_EMAIL' | 'CAMPAIGN_TYPE_SAMPLES' | 'CAMPAIGN_TYPE_SUBSTITUTIONS' | 'CAMPAIGN_TYPE_PAST_ORDERS'
      - `fromTime` string, date-time — fromTime
      - `toTime` string, date-time — toTime

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Login failed or token not valid.
- `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/versions/a040003c7378/schema)