Skip to main content

This page is also available as plain markdown · OpenAPI spec

Update registration

PATCH 
/registrations/:id

Update registration

Request​

Path Parameters

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

Body

attendeeobject
firstNamestring
lastNamestring
emailstring
resendTicketboolean
answersobject[]
questionIdstring
contentstring
Example (auto)
{
  "attendee": {
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "resendTicket": true,
  "answers": [
    {
      "questionId": "string",
      "content": "string"
    }
  ]
}

200

Updates the attendee details
objectstringrequired
idstringrequired
statusstringrequired
checkedInAtstringnullablerequired
attendeeobjectrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
seatstringnullablerequired
relatedRegistrationIdsundefined[]required
eventIdstringrequired
occurrenceIdstringrequired
ticketIdstringrequired
orderIdstringrequired
createdAtstringrequired
updatedAtstringrequired
metaobjectrequired
requestIdstringrequired
Example: updates_the_attendee_details
{
  "object": "registration",
  "id": "d0a99332-0985-4033-83e9-97f869311035",
  "status": "active",
  "checkedInAt": null,
  "attendee": {
    "firstName": "Robert",
    "lastName": "Kunde",
    "email": "bob@example.com"
  },
  "seat": null,
  "relatedRegistrationIds": [],
  "eventId": "3782416a-630b-4116-8a7d-87583f90f2f4",
  "occurrenceId": "3568757f-0a3a-4fe9-bb69-f6f6771fb3fd",
  "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "orderId": "T354828371",
  "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 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"
  }
}

422

Returns 422 for a canceled registration
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
messagestring
fieldstring
metaobjectrequired
requestIdstringrequired
Example: returns_422_for_a_canceled_registration
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "Cannot edit a ticket that has been canceled."
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}