Change the wording of a booking text. Unknown placeholders are refused; the deposit link text needs {pay_link} and the deposit-not-paid text {book_link}. Empty wording or reset: true restores the built-in wording. Needs comms:write or settings:write

put/api/v1/comms/text-templates/{kind}

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/comms/text-templates/{kind}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

kindstring required

Request body

bodystring

The wording with placeholders such as {first_name}, {business}, {service}, {day}, {date}, {time}, {staff}, {ref}, {link}; {pay_link} and {minutes} in the deposit link text; {book_link} in the cancellation and expiry texts. Empty means the built-in wording

resetboolean

true: use the built-in wording again

expected_versioninteger

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.