Sign in
Campaigns

Update Campaign

This method allows the calling application to partial update a Campaign by Campaign Id. If you are updating an array it is recommended to use the PUT /campaigns endpoint instead.

patch/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.

Request body

typeType — unresolved $ref
classClass — unresolved $ref
versionVersion — unresolved $ref
statusStatus — unresolved $ref
detailsDetails — unresolved $ref
settingsSettings — unresolved $ref
suppliersSuppliers — unresolved $ref
rulesRules — unresolved $ref
partnersPartners — unresolved $ref
distributionChannelsDistributionChannels — unresolved $ref
windowsWindows — unresolved $ref
datesDates — unresolved $ref
compatibilityCompatibility — unresolved $ref
incompatibilityIncompatibility — unresolved $ref
offerOffer — unresolved $ref
barcodeBarcode — unresolved $ref
customCustom — unresolved $ref

Response

OK.

idId — unresolved $ref
typeType — unresolved $ref
classClass — unresolved $ref
versionVersion — unresolved $ref
referenceReference — unresolved $ref
statusStatus — unresolved $ref
dateCreatedDateCreated — unresolved $ref
lastUpdatedLastUpdated — unresolved $ref
lastUpdatedByLastUpdatedBy — unresolved $ref
detailsDetails — unresolved $ref
settingsSettings — unresolved $ref
suppliersSuppliers — unresolved $ref
rulesRules — unresolved $ref
partnersPartners — unresolved $ref
distributionChannelsDistributionChannels — unresolved $ref
windowsWindows — unresolved $ref
datesDates — unresolved $ref
compatibilityCompatibility — unresolved $ref
incompatibilityIncompatibility — unresolved $ref
offerOffer — unresolved $ref
barcodeBarcode — unresolved $ref
customCustom — unresolved $ref

Changes