Update a ticket type

Minimum role: ADMIN. Active workspace via the X-Workspace-Id header.

PATCH/ticket-types/{id}

Authorization

AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Path parameters

idstringrequired

Header parameters

X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request body

requiredapplication/json

namestring

min length 1

descriptionstring | null

Show properties

Any of:

string

string

null

null

pricenumber

min 0

currencystring

capacityinteger

max 9007199254740991

maxPerOrderinteger

max 9007199254740991

isVisibleboolean

organizerAbsorbsFeeboolean

saleStartsAtstring<date-time> | null

Show properties

Any of:

string<date-time>

string<date-time>

null

null

saleEndsAtstring<date-time> | null

Show properties

Any of:

string<date-time>

string<date-time>

null

null

seatsioCategoryKeystring | null

Show properties

Any of:

string

string

null

null

Responses

200

dataTicketTyperequired

Show properties

idstringrequired

eventDateIdstringrequired

namestringrequired

descriptionstring | nullrequired

Show properties

Any of:

string

string

null

null

pricenumberrequired

currencystringrequired

capacityintegerrequired

min -9007199254740991 · max 9007199254740991

soldintegerrequired

min -9007199254740991 · max 9007199254740991

availableintegerrequired

min -9007199254740991 · max 9007199254740991

soldOutbooleanrequired

maxPerOrderintegerrequired

min -9007199254740991 · max 9007199254740991

saleStartsAtstring | nullrequired

Show properties

Any of:

string

string

null

null

saleEndsAtstring | nullrequired

Show properties

Any of:

string

string

null

null

isVisiblebooleanrequired

organizerAbsorbsFeebooleanrequired

buyerServiceFeenumberrequired

seatingSurchargenumberrequired

ivanumberrequired

buyerTotalnumberrequired

seatsioCategoryKeystring | nullrequired

Show properties

Any of:

string

string

null

null

priceStagesTicketPriceStage[]

Price stages preceding the final price, ordered by sortOrder. [] = fixed price. Absent if the response does not include them.

Show properties

Array of TicketPriceStage

idstringrequired

namestringrequired

pricenumberrequired

sortOrderintegerrequired

min -9007199254740991 · max 9007199254740991

endsAtstring | nullrequired

Closes once this date passes (ISO 8601). null = no date cutoff.

Show properties

Any of:

string

string

null

null

quantityinteger | nullrequired

Tickets at this price. The cutoff is CUMULATIVE across the ticket type: the stage closes when sold + reserved reaches the sum of quantity for this stage and all previous ones. null = no quantity cutoff.

Show properties

Any of:

integer

integer

null

null

isCurrentbooleanrequired

true for the stage currently in effect (the first one still open). If none is, the ticket type's price applies.

currentPricenumber

CURRENT base price per unit (the open stage, or price if none). Present alongside priceStages.

createdAtstringrequired

401

Missing or invalid credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

403

Insufficient role or resource not accessible.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

404

Resource does not exist or is out of scope.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

422

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*X-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Bodyapplication/json

namestringdescriptionstringpricenumbercurrencystringcapacityintegermaxPerOrderintegerisVisiblebooleanorganizerAbsorbsFeebooleansaleStartsAtstringsaleEndsAtstringseatsioCategoryKeystring

Request

curl -X PATCH 'https://admin.appfreeticket.com/api/v1/ticket-types/string' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "price": 0,
  "currency": "string",
  "capacity": 1,
  "maxPerOrder": 1,
  "isVisible": true,
  "organizerAbsorbsFee": true,
  "saleStartsAt": "2019-08-24T14:15:22Z",
  "saleEndsAt": "2019-08-24T14:15:22Z",
  "seatsioCategoryKey": "string"
}'

const response = await fetch("https://admin.appfreeticket.com/api/v1/ticket-types/string", {
  method: "PATCH",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"price\": 0,\n  \"currency\": \"string\",\n  \"capacity\": 1,\n  \"maxPerOrder\": 1,\n  \"isVisible\": true,\n  \"organizerAbsorbsFee\": true,\n  \"saleStartsAt\": \"2019-08-24T14:15:22Z\",\n  \"saleEndsAt\": \"2019-08-24T14:15:22Z\",\n  \"seatsioCategoryKey\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://admin.appfreeticket.com/api/v1/ticket-types/string",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"price\": 0,\n  \"currency\": \"string\",\n  \"capacity\": 1,\n  \"maxPerOrder\": 1,\n  \"isVisible\": true,\n  \"organizerAbsorbsFee\": true,\n  \"saleStartsAt\": \"2019-08-24T14:15:22Z\",\n  \"saleEndsAt\": \"2019-08-24T14:15:22Z\",\n  \"seatsioCategoryKey\": \"string\"\n}",
)

Response

{
  "data": {
    "id": "string",
    "eventDateId": "string",
    "name": "string",
    "description": "string",
    "price": 0,
    "currency": "string",
    "capacity": -9007199254740991,
    "sold": -9007199254740991,
    "available": -9007199254740991,
    "soldOut": true,
    "maxPerOrder": -9007199254740991,
    "saleStartsAt": "string",
    "saleEndsAt": "string",
    "isVisible": true,
    "organizerAbsorbsFee": true,
    "buyerServiceFee": 0,
    "seatingSurcharge": 0,
    "iva": 0,
    "buyerTotal": 0,
    "seatsioCategoryKey": "string",
    "priceStages": [
      {
        "id": "string",
        "name": "string",
        "price": 0,
        "sortOrder": -9007199254740991,
        "endsAt": "string",
        "quantity": -9007199254740991,
        "isCurrent": true
      }
    ],
    "currentPrice": 0,
    "createdAt": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}