Skip to main content

This page is also available as plain markdown · OpenAPI spec

Update ticket

PATCH 
/events/:eventId/tickets/:id

Update ticket

Request​

Path Parameters

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

Body

namestring
hiddenboolean
kindstring
priceinteger
Example (auto)
{
  "name": "string",
  "hidden": true,
  "kind": "string",
  "price": 0
}

200

Coerces a paid pass to a free pass when price is set to zero
objectstringrequired
idstringrequired
namestringrequired
descriptionnullablerequired
kindstringrequired
attendanceTypestringrequired
pricingModestringrequired
pricenumber<float>required
feenumber<float>required
currencystringrequired
quantitynullablerequired
quantityPerOrdernullablerequired
quantityPerMembernullablerequired
quantityPerListnullablerequired
secretCodenullablerequired
salesStartAtnullablerequired
salesEndHoursintegerrequired
salesEndRulestringrequired
transferAllowedbooleanrequired
showOnEventPagebooleanrequired
seatsCategoryKeysundefined[]required
additionalEventIdsundefined[]required
hiddenbooleanrequired
createdAtstringrequired
updatedAtstringrequired
occurrenceIdsnullablerequired
metaobjectrequired
requestIdstringrequired
Example: updates_a_single_field
{
  "object": "ticket",
  "id": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "name": "Renamed",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 9.99,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "beforeEvent",
  "transferAllowed": true,
  "showOnEventPage": false,
  "seatsCategoryKeys": [],
  "additionalEventIds": [],
  "hidden": false,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "occurrenceIds": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: hides_via_hidden=true
{
  "object": "ticket",
  "id": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "name": "General Admission",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 9.99,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "beforeEvent",
  "transferAllowed": true,
  "showOnEventPage": false,
  "seatsCategoryKeys": [],
  "additionalEventIds": [],
  "hidden": true,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "occurrenceIds": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: unhides_via_hidden=false
{
  "object": "ticket",
  "id": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "name": "General Admission",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 9.99,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "beforeEvent",
  "transferAllowed": true,
  "showOnEventPage": false,
  "seatsCategoryKeys": [],
  "additionalEventIds": [],
  "hidden": false,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "occurrenceIds": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: keeps_paid_pass_when_free_pass_is_requested_but_the_price_stays_positive
{
  "object": "ticket",
  "id": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "name": "General Admission",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 9.99,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "beforeEvent",
  "transferAllowed": true,
  "showOnEventPage": false,
  "seatsCategoryKeys": [],
  "additionalEventIds": [],
  "hidden": false,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "occurrenceIds": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: coerces_a_paid_pass_to_a_free_pass_when_price_is_set_to_zero
{
  "object": "ticket",
  "id": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "name": "General Admission",
  "description": null,
  "kind": "free_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 0,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "beforeEvent",
  "transferAllowed": true,
  "showOnEventPage": false,
  "seatsCategoryKeys": [],
  "additionalEventIds": [],
  "hidden": false,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "occurrenceIds": null,
  "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

Updates a ticket
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

404

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

422

Hide rolls back when other field is invalid
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
fieldstring
messagestring
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "meta": {
    "requestId": "string"
  }
}