Preview scheduling or cancellation against current evidence and queued requests

POST /v1/integration/merchants/{id}/access/rules/{ruleId}/preview

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "rule": {
    "id": "<string>",
    "offerId": "<string>",
    "revision": 123,
    "status": "draft",
    "name": "<string>",
    "audience": {
      "kind": "everyone"
    },
    "opensAt": "<string>",
    "closesAt": "<string>"
  },
  "action": "schedule",
  "expiresAt": "<string>",
  "observedAt": "<string>",
  "impact": {
    "total": 123,
    "earlier": 123,
    "later": 123,
    "unchanged": 123
  },
  "timeZone": "<string>",
  "generalSaleAt": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

ruleId · string · required

Body

application/json

action · enum<string> · required

Available options: schedule, cancel

Response

200 - application/json

Default Response

id · string · required

rule · object · required

Show child attributes

action · enum<string> · required

Available options: schedule, cancel

expiresAt · string · required

observedAt · string · required

impact · object · required

Show child attributes

timeZone · string · required

generalSaleAt · null | string · required