Skip to content

Custom API

Getting in copy

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

Getting in copy

Three optional one-liners that answer what a guest asks on the way to the door: where do I park, how do I get in, when should I turn up. They are plain text, they are yours to write, and a blank one is simply not shown.

Where they live

A listing owns them, not a place. Two organizers using the same room answer these differently, so the copy sits on the thing a guest opens:

ListingRowEndpoint
A series (a run)productionPOST / PATCH /v1/productions
A standalone showeventPOST / PATCH /v1/events

A show inside a series does not answer separately. Guests buy that run on the series page, so the series answers once for every date in it.

The three fields

FieldAsksExample
getting_in_parkingWhere do I park?Free lot behind the building, enter from First.
getting_in_accessHow do I get in?Step-free side door, staff will let you in.
getting_in_arrivalWhen should I turn up?Doors at 7, music at 8.

Each one is a string of at most 200 characters, or null. Send null to clear a line. Leave a key out and that line is untouched, so a patch that sets parking never wipes arrival.

Writing a line

curl -X PATCH https://api.axyn.events/v1/productions/PRODUCTION_ID \
  -H "Authorization: Bearer $AXYN_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "getting_in_parking": "Free lot behind the building, enter from First.",
    "getting_in_arrival": "Doors at 7, music at 8."
  }'

The same three keys work on POST /v1/events and PATCH /v1/events/{eventId}.

What the API does to your text

The copy is stored sanitized, so what you read back is what a guest sees:

  • Newlines, tabs, and runs of spaces collapse to single spaces. One line.
  • Em and en dashes become plain hyphens. House style.
  • Angle brackets are removed, so pasted markup can never render as markup.
  • A line that is empty after that is stored as null.
  • Over 200 characters after that is a 400, not a silent trim.

Reading them back

GET /v1/events/{eventId} and GET /v1/productions/{productionId} return the three fields alongside the rest of the listing. Duplicating a show copies them, because the new date is usually in the same room.

Render each non-null line and skip the rest. If all three are null, show no "Getting in" block at all: an empty heading tells a guest nothing. The AXYN hosted page does exactly that, under the venue map.

Related: Organizer seating for where guests sit once inside.