Skip to content

Custom API

Who it is for

Reference only. Not a decision unless cited in product/DECISIONS.md.

Who it is for

Who it is for is one short line that tells a guest whether a night is meant for them. It is listing copy. It is not a door ID check and it never blocks checkout. If the box is empty, do not show the section.

What to write

Plain language, in the organizer's own words. Examples: All ages, 21+ with ID, Families welcome, Industry trade only. The Setup box offers those four as starter chips. A chip appends its phrase to whatever is already typed, so an organizer can click 21+ with ID and keep typing Industry tasting after 9pm. The saved value is the whole freeform string, never a fixed list.

Maximum 280 characters. Tags are stripped and whitespace is collapsed before the value is stored, so a pasted script tag is saved as plain language. An empty or blank box is stored as null.

Where it lives

  • Series (festival): edit on series Setup. Every date on that series shows the series line unless that date sets its own.
  • Child show (one date of a series): Setup offers an optional override. Use it only when that night is not for the same guests as the rest of the series. Leave it blank and the date inherits the series line.
  • Independent event (one show): edit on that event Setup. It is never affected by any series default.

A wine festival can be All ages on the grounds and 21+ with ID for the Sunday pour. The series page keeps All ages. Only the Sunday row shows 21+ with ID.

JSON key

Partners read who_it_is_for (string or null, max 280 characters) on:

  • GET /v1/events/{eventId} buyer EventDetail. This is the effective line: the show override when set, else the series line, else the independent event line.
  • GET /v1/productions/{productionId} only when you read it with a staff JWT (the organizer's own admin read). The partner series catalog read with an API key does not return the series line. Read it from the EventDetail of a show whose who_it_is_for_override is null.
  • Independent and child-show writes: POST /v1/events and PATCH /v1/events/{eventId}
  • Series writes: PATCH /v1/productions/{productionId}

EventDetail.who_it_is_for_override is set only when this child show differs from the series. It is null or omitted when the show inherits, and always omitted for an independent event. Series show rows from GET /v1/productions/{productionId} and GET /v1/productions/{productionId}/events carry the same who_it_is_for_override key on the nights that differ.

Show who_it_is_for when it is present. When a show row has who_it_is_for_override, show that on that row as that show's rule. Hide the heading when the value is empty. Render the string as text. Do not inject it as HTML, and do not fail checkout on it.