API Reference
API Reference
Guides

Create Offer

post
https://api.fidel.uk/v1/offers
Body Params
string
required

Id of the Brand.

string
required

ISO 3166-1 alpha-3 country code where the offer is active.

string
required

Name of the offer, 2 - 50 characters long.

date
required

Starting date when offer starts qualifying transactions in the format YYYY-MM-DDThh:mm:ss.

type
object
daysOfWeek
array of int32s

Array of numbers between 0 and 6 representing the days of the week. Starting on Sunday.

daysOfWeek
date

End date for the offer in the format YYYY-MM-DDThh:mm:ss. Can be at most 1 year from start date (default iIf not set/null)

double
Defaults to 0

Minimum transaction amount to qualify for the offer.

int32
Defaults to null

Number of days before a transaction qualifies for the offer.

schemes
array of strings

Schemes where the offer will qualify. Possible values are [visa, mastercard, amex].

schemes
activation
object
number

Comission rate from total CPA

channels
array of strings

Type of offer, can be in-store and/or online

channels
string

Short offer description

string

Long offer description

boolean

As a content provider, if is an offer subject to approval

customerRecency
object

Offer rule for recency - new users or have not transacted per days cycle

Headers
string
required

application/json

string
required

test/live API secret key.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 months ago

Language
Credentials
Header
Request
Response 
 Choose an example:
application/json
text/plain
Updated 10 months ago