Home
API Reference

Create Campaign

post
https://resources.uk.eagleeye.com/campaigns

This method allows the calling application to create a Campaign.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON Payload.

string

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

string
enum

The class of this Campaign.

Allowed:
integer

The version number of this Campaign that is automatically generated.

string | null

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

string
enum

The status of the Campaign.

details
object
settings
object
suppliers
array of objects
length ≥ 1

An array of objects containing supplier funding information.

suppliers
string | null

The unit identifier of the supplier that is involved with the Campaign.

string | null

The suppliers reference to this Campaign.

string

The funding Account Id that the funds should be debited from.

integer
Defaults to 100

The percentage of the reward that should be funded by this supplier. This value should be 100 where there is only 1 supplier.

rules
object
partners
object

The issuance/redemption/creation partners for this Campaign.

distributionChannels
object of objects

The distribution channels for this Campaign.

windows
object

The date time windows that an Account can be created/issued/redeemed.

dates
object

The exceptions to the Campaign usage windows.

relationships
object | null

Campaign relations.

compatibility
object

The Campaigns that this is compatible with.

incompatibility
object

The Campaigns that this is incompatible with.

offer
object
barcode
object
custom
object
Headers
string
required

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

string
required

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

string
enum

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.

Allowed:
string

Unique Reference for the API transaction within the calling company.

string

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json
response

Updated about 1 month ago