Remove Registration

Description #

You can use the status property of a Registration to manage a list of registrants. However, we provide a DELETE method as a more idiomatic approach if your application doesn’t require the ability to manage multiple registration statuses.

This will update the Registration’s status to be removed. This will remove it from the list of Registrations associated with the Bookable Event and remove the metadata associated with the registration.

URL format #

{data_center_url}/v1/bookable_events/{bookable_event_id}/registrations/{registration_id}

Example Request #

DELETE /v1/bookable_events/{bookable_event_id}/registrations/{registration_id} HTTP/1.1
Host: {data_center_url}
Authorization: Bearer {API_KEY}
Content-Type: application/json; charset=utf-8

Example Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "bookable_event_id": "83hi8qhfiaif",
  "start": "2024-05-07T12:30:00Z",
  "end": "2024-05-07T17:00:00Z",
  "status": "confirmed",
  "registration": {
    "capacity": 5,
    "registered_count": 0,
    "total_count": 1,
    "registrations": [
      {
        "registration_id": "87326",
        "status": "removed",
        "metadata": null
      }
    ]
  }
}

Request parameters #

bookable_event_id required  #

Your application’s unique identifier for the Bookable Event as a String.

registration_id required  #

The String that uniquely identifies the registration within the Bookable Event.

Response parameters #

The Bookable Event resource. See Read Bookable Event