Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Campaigns

Delete Campaign

This method allows the calling application to delete a Campaign.

delete/campaigns/{campaignId}

Path parameters

campaignIdstring int64 required

EES AIR CampaignId ID.

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

Response

OK.

idstring

The Id of a Campaign automatically generated and unique within Eagle Eye AIR.

referencestring nullable

An external reference for this Campaign, unique to each client.

class'COUPON' | 'CONTINUITY' | 'STAMP_CARD'

The class of this Campaign.

typestring

The type of Campaign this is. These types are configured as part of implementation with a client.

versioninteger

The version number of this Campaign that is automatically generated.

status'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'DELETED' | 'PENDING' | 'DRAFT' | 'REJECTED' | 'READY' | 'STOPPED' | 'SUSPENDED'

The status of the Campaign.

dateCreatedstring date-time

This timestamp shows the date-time in UTC when the Campaign was created. This cannot be edited.

lastUpdatedstring date-time

The timestamp shows the date-time in UTC that the Campaign was last updated. This cannot be edited.

lastUpdatedByinteger

The Eagle Eye generated ID of the user or API call that made the last update.

distributionChannelsobject

The distribution channels for this Campaign.

customobject