Skip to main content

This page is also available as plain markdown · OpenAPI spec

Create ticket

POST 
/events/:eventId/tickets

Create ticket

Request​

Path Parameters

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

Body

namestringrequired
kindstringrequired
priceinteger
attendanceTypestringrequired
pricingModestring
minimumPriceinteger
suggestedPriceinteger
secretCodestring
salesEndHoursinteger
salesEndRulestring
Example (auto)
{
  "name": "string",
  "kind": "string",
  "price": 0,
  "attendanceType": "string",
  "pricingMode": "string",
  "minimumPrice": 0,
  "suggestedPrice": 0,
  "secretCode": "string",
  "salesEndHours": 0,
  "salesEndRule": "string"
}

201

Creates a ticket
objectstringrequired
idstringrequired
namestringrequired
descriptionnullablerequired
kindstringrequired
attendanceTypestringrequired
pricingModestringrequired
pricenumber<float>nullablerequired
feenumber<float>required
currencystringrequired
quantitynullablerequired
quantityPerOrdernullablerequired
quantityPerMembernullablerequired
quantityPerListnullablerequired
secretCodestringnullablerequired
salesStartAtnullablerequired
salesEndHoursintegerrequired
salesEndRulestringrequired
transferAllowedbooleanrequired
showOnEventPagebooleanrequired
seatsCategoryKeysundefined[]required
additionalEventIdsundefined[]required
hiddenbooleanrequired
createdAtstringrequired
updatedAtstringrequired
occurrenceIdsnullablerequired
metaobjectrequired
requestIdstringrequired
minimumPricenumber<float>
suggestedPricenumber<float>
Example: creates_a_paid_pass_ticket
{
  "object": "ticket",
  "id": "00000000-0000-4000-8000-000000000005",
  "name": "Early Bird",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 10,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "afterEvent",
  "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: creates_a_free_pass_ticket
{
  "object": "ticket",
  "id": "00000000-0000-4000-8000-000000000005",
  "name": "Free Entry",
  "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": "afterEvent",
  "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: creates_an_add_on_ticket
{
  "object": "ticket",
  "id": "00000000-0000-4000-8000-000000000005",
  "name": "T-shirt",
  "description": null,
  "kind": "add_on",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 5,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "afterEvent",
  "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: creates_a_sliding-scale_paid_pass
{
  "object": "ticket",
  "id": "00000000-0000-4000-8000-000000000005",
  "name": "Early Bird",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "sliding_scale",
  "price": null,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "afterEvent",
  "transferAllowed": true,
  "showOnEventPage": false,
  "seatsCategoryKeys": [],
  "additionalEventIds": [],
  "hidden": false,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "minimumPrice": 5,
  "suggestedPrice": 15,
  "occurrenceIds": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: creates_a_ticket_with_secretcode
{
  "object": "ticket",
  "id": "00000000-0000-4000-8000-000000000005",
  "name": "Early Bird",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 10,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": "VIPONLY",
  "salesStartAt": null,
  "salesEndHours": 0,
  "salesEndRule": "afterEvent",
  "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_paid_pass_with_price=0_to_free_pass
{
  "object": "ticket",
  "id": "00000000-0000-4000-8000-000000000005",
  "name": "Early Bird",
  "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": "afterEvent",
  "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: round-trips_salesendhours_and_salesendrule
{
  "object": "ticket",
  "id": "00000000-0000-4000-8000-000000000005",
  "name": "Early Bird",
  "description": null,
  "kind": "paid_pass",
  "attendanceType": "in_person",
  "pricingMode": "fixed",
  "price": 10,
  "fee": 0,
  "currency": "usd",
  "quantity": null,
  "quantityPerOrder": null,
  "quantityPerMember": null,
  "quantityPerList": null,
  "secretCode": null,
  "salesStartAt": null,
  "salesEndHours": 48,
  "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

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

404

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

422

Returns 422 with field errors
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
fieldstring
messagestring
metaobjectrequired
requestIdstringrequired
Example: returns_422_when_name_is_missing
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "name",
      "message": "can't be blank"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}