Update a ticket type

Updates a ticket type's label, amount, currency, capacity, or position.

Authorization

bearerAuth shows:update, sales:read

AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: shows:update, sales:read

Path Parameters

programId*string

The program id.

ticketTypeId*string

The ticket type id.

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update a ticket type.

kind?string

Kind; the schema's enum lists the values.

Value in

"free"
"paid"
"comp"
"group"
"pwyw"

label?string

Display label.

Length1 <= length <= 120

amount_cents?integer

Amount, in the currency's minor unit (cents).

Range0 <= value <= 9007199254740991

currency?string

ISO 4217 currency code, e.g. USD.

Length3 <= length <= 3

session_id?|

The engagement session id.

min_amount_cents?|

Min amount, in the currency's minor unit (cents).

suggested_amount_cents?|

Suggested amount, in the currency's minor unit (cents).

capacity?|

Maximum number of admissions; null for unlimited.

min_quantity?|null

max_quantity?|null

available_from?|null

available_until?|null

position?integer

Sort position among siblings; lower first.

Range0 <= value <= 9007199254740991

metadata?|

Free-form JSON the caller owns; stored and returned verbatim, never interpreted.

Response Body

`application/json`

`application/problem+json`

{  "id": "string",  "event_id": "string",  "session_id": "string",  "kind": "free",  "label": "string",  "amount_cents": -9007199254740991,  "currency": "string",  "min_amount_cents": -9007199254740991,  "suggested_amount_cents": -9007199254740991,  "capacity": -9007199254740991,  "min_quantity": -9007199254740991,  "max_quantity": -9007199254740991,  "available_from": "string",  "available_until": "string",  "position": -9007199254740991,  "sold_count": -9007199254740991,  "metadata": {    "property1": "string",    "property2": "string"  },  "created_at": "string",  "updated_at": "string"}

{  "type": "../dictionary",  "title": "string",  "status": 0,  "detail": "string",  "code": "invalid_request",  "retry": "permanent",  "details": null}

{  "type": "../dictionary",  "title": "string",  "status": 0,  "detail": "string",  "code": "invalid_request",  "retry": "permanent",  "details": null}

{  "type": "../dictionary",  "title": "string",  "status": 0,  "detail": "string",  "code": "invalid_request",  "retry": "permanent",  "details": null}

{  "type": "../dictionary",  "title": "string",  "status": 0,  "detail": "string",  "code": "invalid_request",  "retry": "permanent",  "details": null}

{  "type": "../dictionary",  "title": "string",  "status": 0,  "detail": "string",  "code": "invalid_request",  "retry": "permanent",  "details": null}

{  "type": "../dictionary",  "title": "string",  "status": 0,  "detail": "string",  "code": "invalid_request",  "retry": "permanent",  "details": null}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

429application/problem+json

503application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`