Shop Words

A shop can pick its own words for seven things, and the booking page, portal, phone app, emails and Dash all use them. A UK shop might say "Hire" instead of "Rental", "Tour" instead of "Experience" and "Start time" instead of "Pickup time".

The words apply to English only. Other languages keep their normal translation.

Endpoints

GET   /v1/settings                (read: localization.terminology)
PATCH /v1/settings/terminology    (write)

Reading needs the settings:read scope. Writing needs settings:write.

The seven words

Word	Choices	other
rental	rental, hire	own word + plural
experience	experience, activity, tour, class, lesson, course, adventure	own word + plural
pickup	pickup, start, collection, checkout	own word
return	return, finish, dropoff, checkin	own word
security_deposit	security_deposit, bond, damage_deposit	own word + plural
customer	customer, guest, client	own word + plural
participant	participant, guest, rider	own word + plural

The first choice is the default. A word left out of a request keeps its current value.

Update the words

curl -X PATCH https://app.equipdash.com/api/v1/settings/terminology \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "terminology": {
      "rental": { "choice": "hire" },
      "experience": { "choice": "tour" },
      "pickup": { "choice": "start" },
      "participant": { "choice": "other", "word": "Diver", "plural": "Divers" }
    }
  }'

You can also send back the words object exactly as GET /v1/settings returned it. shown_as is ignored.

Request fields

Field	Type	Description
terminology.<word>.choice	string	One of the choices above, or other
terminology.<word>.word	string	Required with other. Up to 40 characters
terminology.<word>.plural	string	Optional with other. Defaults to the word plus "s"

Response

The same shape as localization.terminology on GET /v1/settings:

{
  "data": {
    "words": {
      "rental": { "choice": "hire", "shown_as": "Hire" },
      "experience": { "choice": "tour", "shown_as": "Tour" },
      "pickup": { "choice": "start", "shown_as": "Start time" },
      "participant": { "choice": "other", "word": "Diver", "plural": "Divers", "shown_as": "Diver" }
    },
    "tokens": {
      "rental": "hire",
      "rentals": "hires",
      "rent": "hire",
      "rented": "hired",
      "experience": "tour",
      "experiences": "tours",
      "a_experience": "a tour",
      "A_Experience": "A Tour",
      "pickup": "start",
      "pickups": "starts",
      "pickup_time": "start time",
      "pickup_date": "start date",
      "pick_up": "start",
      "picked_up": "started",
      "Pickup_Time": "Start Time",
      "participant": "diver",
      "participants": "divers"
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-09-26T12:00:00+00:00"
  }
}

The response above is shortened. tokens holds every form of every word. Use it to show your own screens in the shop's words: replace :pickup_time with the value, :Pickup_time with the value capitalized, and :PICKUP_TIME with it in capitals.

a_experience carries its article: "an experience", "a tour", "an activity". For a shop's own word the article follows the first letter, so "Outing" gives "an outing". A_Experience is the same in title case ("A Tour").

Errors

An unknown word, an unknown choice, or other with no word returns 422 with the reason in error.details.