Change Campaign Details
curl --request PATCH \
--url https://omnicommerce.ai/api/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedRevision": 123
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({expectedRevision: 123})
};
fetch('https://omnicommerce.ai/api/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.ai/api/v1/campaigns/{campaignId}"
payload = { "expectedRevision": 123 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"campaign": {
"id": "<string>",
"organizationId": "<string>",
"revision": 0,
"stage": "draft",
"approval": {
"revision": 0,
"userId": "<string>",
"approvedAt": "<string>"
},
"runId": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"plan": {
"brief": {
"name": "<string>",
"ownerId": "<string>",
"approverId": "<string>",
"timezone": "<string>",
"objective": "",
"brand": "",
"stores": [],
"serviceRequest": "",
"priority": "standard",
"documentIds": [],
"reviewDueAt": "2023-11-07T05:31:56Z",
"sourceCurrency": "<string>",
"sourceMarketplace": "shopee",
"sourceCountry": "<string>",
"syncMode": "offer_windows",
"cleanupNotes": ""
},
"windows": [],
"offers": [
{
"id": "<string>",
"windowId": "<string>",
"promotion": {
"name": "<string>",
"description": "<string>",
"kind": "product_discount",
"salesChannels": [
"pdp"
],
"discountType": "percentage",
"discountValue": 1,
"storeDiscounts": [
{
"storeKey": "<string>",
"discountType": "percentage",
"discountValue": 1
}
],
"targetStores": [
{
"marketplace": "lazada",
"country": "<string>",
"storeId": "<string>"
}
],
"minSalePrice": 1,
"maxDiscountAmount": 1,
"minSpend": 1,
"voucherCode": "<string>",
"claimStartsAt": "2023-11-07T05:31:56Z",
"totalUsageLimit": 4503599627370495,
"perBuyerLimit": 4503599627370495,
"mechanicConfig": {
"voucherType": "shopee_shop",
"voucherCampaign": {
"campaignId": "<string>",
"sessionId": "<string>",
"termsAccepted": true
},
"browserAutomation": {
"aopId": "<string>",
"variableValues": {},
"instructions": "<string>"
},
"voucherScope": "products",
"voucherReward": "discount",
"voucherAudience": "general",
"repeatPurchaseMinCount": 500,
"repeatPurchaseLookbackDays": 183,
"smartVoucher": true,
"followPrizeExpiryDays": 15,
"videoDisplayMode": "shopee_video",
"exclusiveCreatorUsernames": [
"<string>"
],
"exclusiveStreamerUsernames": [
"<string>"
],
"voucherDisplayChannels": [
"all"
],
"bundlePriceType": "discount",
"bundleTiers": [
{
"minimumQuantity": 1501,
"discountValue": 123
}
],
"thresholdType": "item_quantity",
"thresholdValue": 123,
"giftType": "gift",
"giftQuantity": 123,
"gifts": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalClaimLimit": 50000,
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"buyQuantity": 123,
"getQuantity": 123,
"benefitProductIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"benefitType": "free",
"benefitValue": 1,
"maxApplicationsPerOrder": 123,
"bundleMinimumQuantity": 1501,
"shippingDeliveryOption": "<string>",
"shippingBudget": 123
}
},
"promotionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productIds": [],
"reviewNotes": "",
"excludedReason": "",
"source": {
"sheet": "<string>",
"rows": [
123
],
"headers": [
"<string>"
],
"values": [
[
"<string>"
]
]
}
}
]
},
"pendingChange": {
"version": 0,
"plan": {
"brief": {
"name": "<string>",
"ownerId": "<string>",
"approverId": "<string>",
"timezone": "<string>",
"objective": "",
"brand": "",
"stores": [],
"serviceRequest": "",
"priority": "standard",
"documentIds": [],
"reviewDueAt": "2023-11-07T05:31:56Z",
"sourceCurrency": "<string>",
"sourceMarketplace": "shopee",
"sourceCountry": "<string>",
"syncMode": "offer_windows",
"cleanupNotes": ""
},
"windows": [],
"offers": [
{
"id": "<string>",
"windowId": "<string>",
"promotion": {
"name": "<string>",
"description": "<string>",
"kind": "product_discount",
"salesChannels": [
"pdp"
],
"discountType": "percentage",
"discountValue": 1,
"storeDiscounts": [
{
"storeKey": "<string>",
"discountType": "percentage",
"discountValue": 1
}
],
"targetStores": [
{
"marketplace": "lazada",
"country": "<string>",
"storeId": "<string>"
}
],
"minSalePrice": 1,
"maxDiscountAmount": 1,
"minSpend": 1,
"voucherCode": "<string>",
"claimStartsAt": "2023-11-07T05:31:56Z",
"totalUsageLimit": 4503599627370495,
"perBuyerLimit": 4503599627370495,
"mechanicConfig": {
"voucherType": "shopee_shop",
"voucherCampaign": {
"campaignId": "<string>",
"sessionId": "<string>",
"termsAccepted": true
},
"browserAutomation": {
"aopId": "<string>",
"variableValues": {},
"instructions": "<string>"
},
"voucherScope": "products",
"voucherReward": "discount",
"voucherAudience": "general",
"repeatPurchaseMinCount": 500,
"repeatPurchaseLookbackDays": 183,
"smartVoucher": true,
"followPrizeExpiryDays": 15,
"videoDisplayMode": "shopee_video",
"exclusiveCreatorUsernames": [
"<string>"
],
"exclusiveStreamerUsernames": [
"<string>"
],
"voucherDisplayChannels": [
"all"
],
"bundlePriceType": "discount",
"bundleTiers": [
{
"minimumQuantity": 1501,
"discountValue": 123
}
],
"thresholdType": "item_quantity",
"thresholdValue": 123,
"giftType": "gift",
"giftQuantity": 123,
"gifts": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalClaimLimit": 50000,
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"buyQuantity": 123,
"getQuantity": 123,
"benefitProductIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"benefitType": "free",
"benefitValue": 1,
"maxApplicationsPerOrder": 123,
"bundleMinimumQuantity": 1501,
"shippingDeliveryOption": "<string>",
"shippingBudget": 123
}
},
"promotionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productIds": [],
"reviewNotes": "",
"excludedReason": "",
"source": {
"sheet": "<string>",
"rows": [
123
],
"headers": [
"<string>"
],
"values": [
[
"<string>"
]
]
}
}
]
},
"proposedBy": "<string>",
"proposedAt": "<string>"
}
},
"executions": [
{
"offerId": "<string>",
"windowId": "<string>",
"promotionId": "<string>",
"state": "draft",
"error": "<string>",
"evidence": "<unknown>",
"termsRevision": 0
}
],
"audit": [
{
"id": "<string>",
"action": "<string>",
"actorId": "<string>",
"actorName": "<string>",
"createdAt": "<string>",
"details": {},
"summary": "<string>",
"items": [
{
"kind": "brief",
"action": "add",
"id": "<string>",
"name": "<string>",
"changes": [
{
"field": "<string>",
"label": "<string>",
"from": "<string>",
"to": "<string>"
}
]
}
],
"hiddenCount": 4503599627370495
}
],
"readiness": [
"<string>"
],
"pendingChangeIssues": [
"<string>"
],
"pendingScheduleCount": 4503599627370495,
"failedScheduleCount": 4503599627370495,
"waitingBrowserJobCount": 4503599627370495,
"scheduleIssues": [
{
"windowId": "<string>",
"phase": "prepare",
"kind": "overdue"
}
],
"recovery": [
{
"windowId": "<string>",
"phase": "prepare",
"state": "<string>",
"attempt": 0,
"nextRetryAt": "<string>",
"error": "<string>"
}
],
"cleanupFailed": true,
"progress": {
"asOf": "<string>",
"title": "<string>",
"description": "<string>",
"total": 4503599627370495,
"counts": {
"waiting": 4503599627370495,
"preparing": 4503599627370495,
"prepared": 4503599627370495,
"live": 4503599627370495,
"ending": 4503599627370495,
"ended": 4503599627370495,
"cancelled": 4503599627370495,
"failed": 4503599627370495
},
"issues": [
{
"offerId": "<string>",
"name": "<string>",
"error": "<string>"
}
],
"scheduleIssues": [
{
"windowId": "<string>",
"phase": "prepare",
"kind": "overdue",
"name": "<string>",
"message": "<string>"
}
],
"blockers": [
"<string>"
],
"nextWindow": {
"id": "<string>",
"name": "<string>",
"preparesAt": "<string>",
"startsAt": "<string>",
"endsAt": "<string>"
}
}
}Campaigns
Change Campaign Details
Partially edit the brief, upsert windows and promotion offers by stable id, or explicitly remove offer/window IDs. Omitted fields and children stay unchanged. Uses the campaign editor’s canonical merger and marketplace validation.
Running edits build on the pending proposal and require named-approver approval before delivery. Send expectedRevision; expectedPendingVersion can guard a reviewed proposal (null for none). Requires promotions:write.
PATCH
/
api
/
v1
/
campaigns
/
{campaignId}
Change Campaign Details
curl --request PATCH \
--url https://omnicommerce.ai/api/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedRevision": 123
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({expectedRevision: 123})
};
fetch('https://omnicommerce.ai/api/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.ai/api/v1/campaigns/{campaignId}"
payload = { "expectedRevision": 123 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"campaign": {
"id": "<string>",
"organizationId": "<string>",
"revision": 0,
"stage": "draft",
"approval": {
"revision": 0,
"userId": "<string>",
"approvedAt": "<string>"
},
"runId": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"plan": {
"brief": {
"name": "<string>",
"ownerId": "<string>",
"approverId": "<string>",
"timezone": "<string>",
"objective": "",
"brand": "",
"stores": [],
"serviceRequest": "",
"priority": "standard",
"documentIds": [],
"reviewDueAt": "2023-11-07T05:31:56Z",
"sourceCurrency": "<string>",
"sourceMarketplace": "shopee",
"sourceCountry": "<string>",
"syncMode": "offer_windows",
"cleanupNotes": ""
},
"windows": [],
"offers": [
{
"id": "<string>",
"windowId": "<string>",
"promotion": {
"name": "<string>",
"description": "<string>",
"kind": "product_discount",
"salesChannels": [
"pdp"
],
"discountType": "percentage",
"discountValue": 1,
"storeDiscounts": [
{
"storeKey": "<string>",
"discountType": "percentage",
"discountValue": 1
}
],
"targetStores": [
{
"marketplace": "lazada",
"country": "<string>",
"storeId": "<string>"
}
],
"minSalePrice": 1,
"maxDiscountAmount": 1,
"minSpend": 1,
"voucherCode": "<string>",
"claimStartsAt": "2023-11-07T05:31:56Z",
"totalUsageLimit": 4503599627370495,
"perBuyerLimit": 4503599627370495,
"mechanicConfig": {
"voucherType": "shopee_shop",
"voucherCampaign": {
"campaignId": "<string>",
"sessionId": "<string>",
"termsAccepted": true
},
"browserAutomation": {
"aopId": "<string>",
"variableValues": {},
"instructions": "<string>"
},
"voucherScope": "products",
"voucherReward": "discount",
"voucherAudience": "general",
"repeatPurchaseMinCount": 500,
"repeatPurchaseLookbackDays": 183,
"smartVoucher": true,
"followPrizeExpiryDays": 15,
"videoDisplayMode": "shopee_video",
"exclusiveCreatorUsernames": [
"<string>"
],
"exclusiveStreamerUsernames": [
"<string>"
],
"voucherDisplayChannels": [
"all"
],
"bundlePriceType": "discount",
"bundleTiers": [
{
"minimumQuantity": 1501,
"discountValue": 123
}
],
"thresholdType": "item_quantity",
"thresholdValue": 123,
"giftType": "gift",
"giftQuantity": 123,
"gifts": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalClaimLimit": 50000,
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"buyQuantity": 123,
"getQuantity": 123,
"benefitProductIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"benefitType": "free",
"benefitValue": 1,
"maxApplicationsPerOrder": 123,
"bundleMinimumQuantity": 1501,
"shippingDeliveryOption": "<string>",
"shippingBudget": 123
}
},
"promotionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productIds": [],
"reviewNotes": "",
"excludedReason": "",
"source": {
"sheet": "<string>",
"rows": [
123
],
"headers": [
"<string>"
],
"values": [
[
"<string>"
]
]
}
}
]
},
"pendingChange": {
"version": 0,
"plan": {
"brief": {
"name": "<string>",
"ownerId": "<string>",
"approverId": "<string>",
"timezone": "<string>",
"objective": "",
"brand": "",
"stores": [],
"serviceRequest": "",
"priority": "standard",
"documentIds": [],
"reviewDueAt": "2023-11-07T05:31:56Z",
"sourceCurrency": "<string>",
"sourceMarketplace": "shopee",
"sourceCountry": "<string>",
"syncMode": "offer_windows",
"cleanupNotes": ""
},
"windows": [],
"offers": [
{
"id": "<string>",
"windowId": "<string>",
"promotion": {
"name": "<string>",
"description": "<string>",
"kind": "product_discount",
"salesChannels": [
"pdp"
],
"discountType": "percentage",
"discountValue": 1,
"storeDiscounts": [
{
"storeKey": "<string>",
"discountType": "percentage",
"discountValue": 1
}
],
"targetStores": [
{
"marketplace": "lazada",
"country": "<string>",
"storeId": "<string>"
}
],
"minSalePrice": 1,
"maxDiscountAmount": 1,
"minSpend": 1,
"voucherCode": "<string>",
"claimStartsAt": "2023-11-07T05:31:56Z",
"totalUsageLimit": 4503599627370495,
"perBuyerLimit": 4503599627370495,
"mechanicConfig": {
"voucherType": "shopee_shop",
"voucherCampaign": {
"campaignId": "<string>",
"sessionId": "<string>",
"termsAccepted": true
},
"browserAutomation": {
"aopId": "<string>",
"variableValues": {},
"instructions": "<string>"
},
"voucherScope": "products",
"voucherReward": "discount",
"voucherAudience": "general",
"repeatPurchaseMinCount": 500,
"repeatPurchaseLookbackDays": 183,
"smartVoucher": true,
"followPrizeExpiryDays": 15,
"videoDisplayMode": "shopee_video",
"exclusiveCreatorUsernames": [
"<string>"
],
"exclusiveStreamerUsernames": [
"<string>"
],
"voucherDisplayChannels": [
"all"
],
"bundlePriceType": "discount",
"bundleTiers": [
{
"minimumQuantity": 1501,
"discountValue": 123
}
],
"thresholdType": "item_quantity",
"thresholdValue": 123,
"giftType": "gift",
"giftQuantity": 123,
"gifts": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalClaimLimit": 50000,
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"buyQuantity": 123,
"getQuantity": 123,
"benefitProductIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"benefitType": "free",
"benefitValue": 1,
"maxApplicationsPerOrder": 123,
"bundleMinimumQuantity": 1501,
"shippingDeliveryOption": "<string>",
"shippingBudget": 123
}
},
"promotionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productIds": [],
"reviewNotes": "",
"excludedReason": "",
"source": {
"sheet": "<string>",
"rows": [
123
],
"headers": [
"<string>"
],
"values": [
[
"<string>"
]
]
}
}
]
},
"proposedBy": "<string>",
"proposedAt": "<string>"
}
},
"executions": [
{
"offerId": "<string>",
"windowId": "<string>",
"promotionId": "<string>",
"state": "draft",
"error": "<string>",
"evidence": "<unknown>",
"termsRevision": 0
}
],
"audit": [
{
"id": "<string>",
"action": "<string>",
"actorId": "<string>",
"actorName": "<string>",
"createdAt": "<string>",
"details": {},
"summary": "<string>",
"items": [
{
"kind": "brief",
"action": "add",
"id": "<string>",
"name": "<string>",
"changes": [
{
"field": "<string>",
"label": "<string>",
"from": "<string>",
"to": "<string>"
}
]
}
],
"hiddenCount": 4503599627370495
}
],
"readiness": [
"<string>"
],
"pendingChangeIssues": [
"<string>"
],
"pendingScheduleCount": 4503599627370495,
"failedScheduleCount": 4503599627370495,
"waitingBrowserJobCount": 4503599627370495,
"scheduleIssues": [
{
"windowId": "<string>",
"phase": "prepare",
"kind": "overdue"
}
],
"recovery": [
{
"windowId": "<string>",
"phase": "prepare",
"state": "<string>",
"attempt": 0,
"nextRetryAt": "<string>",
"error": "<string>"
}
],
"cleanupFailed": true,
"progress": {
"asOf": "<string>",
"title": "<string>",
"description": "<string>",
"total": 4503599627370495,
"counts": {
"waiting": 4503599627370495,
"preparing": 4503599627370495,
"prepared": 4503599627370495,
"live": 4503599627370495,
"ending": 4503599627370495,
"ended": 4503599627370495,
"cancelled": 4503599627370495,
"failed": 4503599627370495
},
"issues": [
{
"offerId": "<string>",
"name": "<string>",
"error": "<string>"
}
],
"scheduleIssues": [
{
"windowId": "<string>",
"phase": "prepare",
"kind": "overdue",
"name": "<string>",
"message": "<string>"
}
],
"blockers": [
"<string>"
],
"nextWindow": {
"id": "<string>",
"name": "<string>",
"preparesAt": "<string>",
"startsAt": "<string>",
"endsAt": "<string>"
}
}
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Path Parameters
Body
application/json
Required range:
x <= 9007199254740991Required string length:
2 - 160Maximum string length:
8000Maximum string length:
160Organization member ID or eligible oauth: actor from campaign options.
Required string length:
1 - 160Explicit named approver: organization member ID or eligible oauth: actor from campaign options. Other users and API clients cannot approve on this actor's behalf.
Required string length:
1 - 160Maximum array length:
100Show child attributes
Show child attributes
Maximum string length:
300Available options:
standard, priority, super_priority Maximum array length:
100Required string length:
1 - 160Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^[A-Z]{3}$Available options:
shopee, lazada, tiktok, shopify, whatsapp, zalora, amazon, ebay Maximum string length:
80Available options:
offer_windows, campaign_start Maximum string length:
8000Add or update promotions by stable offer id. Existing IDs patch only supplied fields; new IDs require windowId and promotion terms. Omitted offers stay unchanged.
Maximum array length:
500Show child attributes
Show child attributes
Add or update windows by stable id. Existing IDs patch only supplied fields; new IDs require name, startsAt and endsAt. Omitted windows stay unchanged.
Maximum array length:
100Show child attributes
Show child attributes
Delete these windows. Move or remove their promotions in the same call. Maximum 100 IDs.
Maximum array length:
100Required string length:
1 - 160Delete these draft promotion offers. Maximum 500 IDs.
Maximum array length:
500Required string length:
1 - 160Required for session auth. Optional for an API key, which already identifies the organization.
Required string length:
1 - 120Required range:
0 < x <= 9007199254740991Response
Campaign detail: plan, revision, executions, audit, schedule, and progress.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Issues that block approving or running the current plan.
Issues that block approving the proposed live change.
Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes