Update Offer

patch

https://api.fidel.uk/v1/offers/{offerId}

Update specific offer properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

offerId

string

required

Id of the offer.

Body Params

name

string

Name of the offer.

startDate

date

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

type

object

activation

object

Offer activation requires offer activation on cards for them to qualify for rewards. Offer activation can be enabled and can also be specified the number of transactions to qualify for each offer activation by using: activation: { enabled: true, qualifiedTransactionsLimit: 1 } NOTE: Enabling activation will disable card linking for any card not added to the offer.

daysOfWeek

array of int32s

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

daysOfWeek

endDate

date

End date for the offer in the format YYYY-MM-DDThh:mm:ss. Can be at most 1 year from start date

minTransactionAmount

double

Minimum transaction amount to qualify for the offer.

returnPeriod

int32

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

additionalTerms

string

Offer T&C

shortDescription

string

Short offer description

longDescription

string

Long offer description

Headers

Content-Type

string

application/json

Fidel-Key

string

test/live API secret key.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200200

400400