Check out registration

POST 
/registrations/:id/check_out

Check out registration

Request

Path Parameters

idstringrequired
Example: 00000000-0000-0000-0000-000000000000

Body

Example (auto)

{}

200

Checks out the registration

objectstringrequired

idstringrequired

statusstringrequired

checkedInAtnullablerequired

attendeeobjectrequired

firstNamestringrequired

lastNamestringrequired

emailstring

seatstringnullablerequired

relatedRegistrationIdsundefined[]

eventIdstringrequired

occurrenceIdstringrequired

ticketIdstringrequired

orderIdstring

createdAtstring

updatedAtstring

metaobjectrequired

requestIdstringrequired

Example: checks_out_the_registration

{
  "object": "registration",
  "id": "acfa16ec-1a09-4d67-85f6-b7db0afb4759",
  "status": "active",
  "checkedInAt": null,
  "attendee": {
    "firstName": "Alice",
    "lastName": "Patron",
    "email": "alice@example.com"
  },
  "seat": "A-12",
  "relatedRegistrationIds": [],
  "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
  "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
  "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "orderId": "T339434021",
  "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 a check-in scope returns 403 when oauth token lacks a check-in scope

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_403_when_oauth_token_lacks_a_check-in_scope

{
  "object": "error",
  "status": 403,
  "message": "Insufficient scope. Required: registrations_checkin or registrations_write",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

404

Returns 404 for non-existent registration

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_404_for_non-existent_registration

{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}