CIcitrusad
bannerXCampaign

Update banner X campaign approval state

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.

post/v3/bannerx-campaigns/{id}:approve

Request

Path parameters

idstring required

The campaign Id

Request body

Response

The campaign approval status has been successfully updated.

Example response

{
  "bannerXCampaign": {
    "id": "abc123xyz",
    "updateTime": "2024-09-01T12:34:56Z",
    "name": "Summer Sale Campaign",
    "namespaceId": "namespace_001",
    "templateId": "template_123",
    "managerTeamId": "manager_team_67890",
    "teamId": "team_12345",
    "startTime": "2024-09-01T12:00:00Z",
    "endTime": "2024-09-30T23:59:59Z",
    "walletId": "wallet_123456789",
    "placementId": "placement_987654321",
    "catalogIds": [
      "catalog_001",
      "catalog_002"
    ],
    "advertisedProducts": {
      "productsByKey": [
        {
          "catalogId": "catalog_001",
          "productCode": "PROD123456",
          "sellerId": "seller_78910"
        }
      ]
    },
    "targeting": {
      "searchTerms": [
        {
          "phrase": "example search term",
          "collectionName": "default_collection",
          "suggested": true,
          "excludedProducts": [
            {
              "catalogId": "catalog_001",
              "productCode": "PROD123456",
              "sellerId": "seller_78910"
            }
          ],
          "maxBid": "100.00",
          "treatAsCustom": true
        }
      ],
      "crossSell": {
        "targetProductsByKey": [
          {
            "catalogId": "catalog_001",
            "productCode": "PROD123456",
            "sellerId": "seller_78910"
          }
        ]
      },
      "upsell": {
        "targetProductsByKey": [
          {
            "catalogId": "catalog_001",
            "productCode": "PROD123456",
            "sellerId": "seller_78910"
          }
        ]
      },
      "excludeFilters": [
        {
          "catalogId": "catalog_12345",
          "filter": "filter_value_abc"
        }
      ],
      "includeFilters": [
        {
          "catalogId": "catalog_12345",
          "filter": "filter_value_abc"
        }
      ]
    },
    "strategy": {
      "auction": {
        "maxBid": "$100.00",
        "spendLimit": {
          "daily": "$50.00",
          "total": "$1000.00"
        }
      },
      "fixedTenancy": {
        "cost": "$99.99",
        "positions": [
          1,
          2,
          3
        ],
        "catalogCosts": [
          {
            "catalogId": "catalog_123456",
            "catalogCostPercentage": 0.25
          }
        ]
      }
    },
    "fixedCosts": {
      "dataCost": "$100.00",
      "creativeCost": "$200.00",
      "otherCost": "$50.00"
    },
    "customFields": [
      {
        "customFieldId": "cfid_12345",
        "content": "This is a custom field content."
      }
    ],
    "customQuestions": [
      {
        "customQuestionId": "cqid_67890",
        "answers": [
          "Answer 1",
          "Answer 2",
          "Answer 3"
        ]
      }
    ],
    "sellerId": "seller_12345",
    "bannerXConfig": {
      "contentStandardId": "content_standard_001",
      "slotId": "slot_001",
      "headingText": "Welcome to our store!",
      "bannerText": "Summer Sale: Up to 50% off!",
      "bannerTextColourHex": "#FF5733",
      "ctaFlag": true,
      "ctaText": "Click Here",
      "ctaTextAccessibility": "Click to learn more",
      "ctaLink": "https://www.example.com",
      "backgroundColourHex": "#FFFFFF",
      "backgroundImageId": "bg_image_001",
      "secondaryBackgroundImageId": "secondary-image-id-123",
      "heroImageId": "hero-image-id-456",
      "heroImageAltText": "This is the hero image.",
      "secondaryHeroImageId": "456defghi",
      "secondaryHeroImageAltText": "Secondary hero image description",
      "additionalFields": [
        {
          "id": "12345abcde",
          "value": "abcd-8798uhu"
        }
      ],
      "trackingTagProvider": [
        {
          "content": "<script src='tracking.js'></script>"
        }
      ],
      "primaryVideoConfig": {
        "fileId": "video-id-1234"
      },
      "companionProducts": [
        {
          "catalogId": "catalog_001",
          "productCode": "PROD123456",
          "sellerId": "seller_78910"
        }
      ]
    },
    "settings": {
      "fromTime": "2024-09-01T12:34:56Z",
      "toTime": "2024-09-01T12:34:56Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.