PApassentry
Batches

Cancel batch

patch/api/v1/batches/{id}/cancel

Request

  • Base URL
    https://api.passentry.com
  • URL
    https://api.passentry.com/api/v1/batches/{id}/cancel
  • Auth
    HTTP bearer

Response

Successful

Example response

{
  "data": {
    "attributes": {
      "name": "PassEntry Supermarket Summer Promotion",
      "tag": "summerPromotion",
      "content": "Welcome to PassEntry Supermarket! We're excited to have you as a member. Get 10% off your first purchase by showing your pass at the till!",
      "totalRecipients": 12000,
      "completedAt": "2021-01-01T00:00:00Z",
      "scheduledAt": "2022-01-01T00:00:00Z",
      "errorsCsvUrl": "https://example.com/errors.csv"
    }
  }
}

Changes

No recorded changes to this operation across all 9 revisions of this API.