v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB

productCampaign

Update product campaign

This endpoint updates an existing product campaign settings. Modify campaign details like name, catalog assignments, and other campaign options.

patch/v3/product-campaigns/{productCampaign.id}

Path parameters

productCampaign.idstring required

The unique identifier of the campaign.

Request body

maskstring

Specifies the productCampaign fields to update. Use a comma-separated string to list the field paths, such as 'name,startTime', ensuring that only these fields are modified during the update process. Fields not included in this list will remain unchanged.

Example request

{
  "productCampaign": {
    "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"
        ]
      }
    ]
  }
}

Response

Details of the updated campaign.

Example response

{
  "productCampaign": {
    "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"
        ]
      }
    ]
  }
}