Skip to main content
POST
Set Promotion Statuses

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
promotionIds
string<uuid>[]
required
Required array length: 1 - 500 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
targetStatus
enum<string>
required
Available options:
active,
paused,
archived
organizationId
string

Required for session auth. Optional for an API key, which already identifies the organization.

Required string length: 1 - 120

Response

Canonical operation result. Inspect aggregate and per-target success and marketplace delivery evidence.

success
boolean
required
succeededCount
integer
required
Required range: 0 <= x <= 9007199254740991
failedCount
integer
required
Required range: 0 <= x <= 9007199254740991
promotionIds
string[]
required
results
object[]
required
targetStatus
enum<string>
Available options:
active,
paused,
archived
updatedCount
integer
Required range: 0 <= x <= 9007199254740991
unchangedCount
integer
Required range: 0 <= x <= 9007199254740991