Promotions | Campaigns

Create a new campaign

post/api/Campaigns

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
  • Auth: API key in header Authorization

Request body

idstring nullable

Unique Id of the campaign. A GUID will be generated if not provided.

namestring required

Campaign display name.

descriptionstring nullable

Optional internal description of the campaign.

tagsstring[] nullable

Tags for categorizing and filtering campaigns.

startDatestring date-time required

Campaign start date.

endDatestring date-time required

Campaign end date. Must be after StartDate.

statusstring nullable

Initial lifecycle status of the campaign. Valid values: Planning, Active, Completed, Archived. Defaults to Planning if not specified.

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.

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.