Promotions | Campaigns

Update the status of a campaign

patch/api/Campaigns/{id}/status

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Campaigns/{id}/status
  • Auth: API key in header Authorization

Path parameters

idstring nullable required

ID of the campaign

Request body

statusstring required

The new status for the campaign. Valid values: Planning, Active, Completed, Archived

Response

Success

idstring nullable

Unique identifier for the campaign.

namestring nullable

Campaign display name.

descriptionstring nullable

Optional internal description of the campaign.

tagsstring[] nullable

Tags for categorizing and filtering campaigns.

startDatestring date-time

Campaign start date.

endDatestring date-time

Campaign end date.

statusstring nullable

Current lifecycle status of the campaign. Valid values: Planning, Active, Completed, Archived

marketsstring[] nullable

Markets where the campaign applies.

storesstring[] nullable

Stores where the campaign applies. Empty means all stores.

planningNotesstring nullable

Internal notes for campaign planning.

createdDatestring date-time nullable

Timestamp when the campaign was created.

updatedDatestring date-time nullable

Timestamp when the campaign was last updated.

Changes

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