Skip to content
campaiDeveloper
campai.com

Booking ยท Events

POST/{organizationId}/booking/events/{eventId}/bookingTemplateChangeReads only

Preview event template change

Previews the effect of selecting a booking template for an event. Provide organizationId, eventId, and bookingTemplate; set bookingTemplate to null to follow the standard template. The response shows whether tickets, wallet passes, and QR check-in would turn on or off, plus the number of issued passes; that count is zero when the resolved template is unchanged. Nothing is saved.

Permissions

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

Who may call it

  • The caller must have organization access.
  • The caller needs event.read before the handler runs.
  • If the event exists, the caller also needs mandate.read for its mandate.

Request

Path parameters

  • organizationIdidrequired
  • eventIdidrequired

Body

Content-Type: application/json

  • bookingTemplateidrequirednullable
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/events/YOUR_EVENT_ID/bookingTemplateChange' \
  --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 setting does not change.

    • passstringnullable
      on off

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

    • qrCheckInstringnullable
      on off

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

  • issuedPassesinteger

    at least 0

    issuedPasses is zero when the same template resolves before and after the selection.

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

Errors

Other errors

StatusErrorWhen
404No fixed messageIf the event is not found in the organization, the request returns HTTP 404 (NOT_FOUND).

Errors nearly every request can meet are listed under Errors.