Skip to content
campaiDeveloper
campai.com

Templates

POST/{organizationId}/templates/booking/{templateId}/outputsChangeReads only

Preview booking template change

Previews the effect of the proposed standard, ticketEnabled and passEnabled settings for a booking template. Returns whether tickets, passes and QR check-in would turn on or off, the number of upcoming events or resources affected, and the number of issued passes. Nothing is saved.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • An organization caller must have template.read.

Request

Path parameters

  • organizationIdidrequired
  • templateIdidrequired

Body

Content-Type: application/json

  • standardbooleanrequired
  • ticketEnabledbooleanrequired
  • passEnabledbooleanrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/booking/YOUR_TEMPLATE_ID/outputsChange' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • changesobject
    3 properties
    • ticketstringnullable
      on off

      changes.ticket is null when the ticket output does not change.

    • passstringnullable
      on off

      changes.pass is null when the pass output does not change.

    • qrCheckInstringnullable
      on off

      changes.qrCheckIn is null when the QR check-in output does not change.

  • countinteger

    at least 0

    count is zero when no ticket or pass output changes.

  • issuedPassesinteger

    at least 0

    issuedPasses is zero when no ticket or pass output changes, even if passes were previously issued.

Response200
{
  "changes": {
    "ticket": "on",
    "pass": "on",
    "qrCheckIn": "on"
  },
  "count": 0,
  "issuedPasses": 0
}

Errors

Other errors

StatusErrorWhen
404No fixed messageReturns HTTP 404 (NOT_FOUND) if the booking template is not found for the organization.

Errors nearly every request can meet are listed under Errors.