Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Card Reports

Create Schedule

Create an automated report schedule for the programme.

post/v2/giftcards/programs/{programId}/reports/schedule

Path parameters

programIdstring required
Example:5eb7cf5a86d9755df3a6c593

Query parameters

cardIdstring
Example:5eb7cf5a86d9755df3a6c593

Headers

X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable

Request body

namestring required
frequencystring required
dayOfWeekinteger nullable
dayOfMonthinteger nullable
hourUtcinteger
formatstring required
recipientsstring[] required
metricsstring[]
includePrivacyNoticeboolean

Response

Successful Response

{"stackTrail":"paths:/v2/giftcards/programs/{programId}/reports/schedule:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}