Skip to main content

This page is also available as plain markdown · OpenAPI spec

Add guest

POST 

/registrations

Add guest

Request​

Body

eventIdstringrequired
ticketIdstringrequired
occurrenceIdstringrequired
paymentMethodstringrequired
attendeeobjectrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
checkInboolean
sendEmailboolean
Example (auto)
{
  "eventId": "string",
  "ticketId": "string",
  "occurrenceId": "string",
  "paymentMethod": "string",
  "attendee": {
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "checkIn": true,
  "sendEmail": true
}

201

Adds a cash guest checked in at the door
objectstringrequired
idstringrequired
statusstringrequired
checkedInAtstringnullablerequired
attendeeobjectrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
seatnullablerequired
relatedRegistrationIdsstring[]required
eventIdstringrequired
occurrenceIdstringrequired
ticketIdstringrequired
orderIdstringrequired
createdAtstringrequired
updatedAtstringrequired
metaobjectrequired
requestIdstringrequired
idempotencyKeystring
idempotentReplayedboolean
Example: adds_a_complimentary_guest
{
  "object": "registration",
  "id": "00000000-0000-4000-8000-000000000009",
  "status": "active",
  "checkedInAt": null,
  "attendee": {
    "firstName": "Dana",
    "lastName": "Doorst",
    "email": "dana@example.com"
  },
  "seat": null,
  "relatedRegistrationIds": [],
  "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
  "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
  "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "orderId": "T572027703",
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: adds_a_cash_guest_checked_in_at_the_door
{
  "object": "registration",
  "id": "00000000-0000-4000-8000-000000000009",
  "status": "active",
  "checkedInAt": "2026-06-15T12:00:00Z",
  "attendee": {
    "firstName": "Dana",
    "lastName": "Doorst",
    "email": "dana@example.com"
  },
  "seat": null,
  "relatedRegistrationIds": [],
  "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
  "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
  "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "orderId": "T572027703",
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

403

When oauth token lacks registrations write scope returns 403 when oauth token lacks registrations write scope
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_403_when_oauth_token_lacks_registrations_write_scope
{
  "object": "error",
  "status": 403,
  "message": "Insufficient scope. Required: registrations_write",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

404

Returns 404 for non-existent event
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_404_for_non-existent_event
{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

422

Returns 422 for an unsupported payment method
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
fieldstring
messagestring
metaobjectrequired
requestIdstringrequired
Example: returns_422_for_an_unsupported_payment_method
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "paymentMethod",
      "message": "must be one of: complimentary, cash"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}