Holds

Create a hold

Creates a new hold

post/v1/holds

Request

Request body application/x-www-form-urlencoded

event_idstring required

The ID of the associated event for which to create the hold

notestring required

A string that gives more information about the created hold

ticket_type_idobject required

List of ticket types and their quantities

Example request

{
  "event_id": "ev_123",
  "note": "This hold contains 5 General Admission tickets",
  "ticket_type_id": {
    "tt_1": 1,
    "tt_2": 5
  }
}

Response

Successfully created a hold

objectstring
idstring

A unque identifier for the hold

event_idstring

ID of the event that the hold belongs to

notestring

A note for the hold

total_on_holdinteger

Total number of tickets on hold

Example response

{
  "object": "hold",
  "id": "ho_1",
  "created_at": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  },
  "note": "This is the note about the hold",
  "total_on_hold": 6,
  "update_at": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  },
  "quantities": [
    {
      "ticket_type_id": "tt_1",
      "quantity": 1
    },
    {
      "ticket_type_id": "tt_2",
      "quantity": 5
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.