Skip to main content
PUT
Update a reminder and its optional form

Authorizations

Authorization
string
header
required

Your personal access token where supported, or a scoped API key (hc_…) created inside HueChat at Account → Developer API. Send it as Authorization: Bearer <token>.

Path Parameters

accountId
integer
required
Required range: x >= 1
reminderId
string<uuid>
required

Body

application/json
name
string
required
timing_type
enum<string>
required
Available options:
before_start,
after_start,
previous_day
inbox_id
integer
required
template_id
string<uuid>
required
bindings
object[]
required
Maximum array length: 30
is_active
boolean
required
resource_id
string<uuid>
minutes_before
integer
Required range: 5 <= x <= 10080
minutes_after
integer
Required range: 5 <= x <= 10080
send_minute
integer
Required range: 0 <= x <= 1439
form_id
string<uuid>

Optional published form in the same account. The approved template must use either its exact dynamic invitation URL button or its exact fixed public URL in BODY text. The fixed BODY mode persists form_id for configuration validation only and does not identify respondents.

stop_after_response
boolean
default:true

Stops private invitation reminders after an appointment-bound response. Must be false when the approved template uses a fixed public form URL in BODY text.

header_media
string
Maximum string length: 512
time_format
enum<string>
Available options:
12h,
24h
eligible_statuses
enum<string>[]
Available options:
tentative,
booked,
confirmed,
completed,
cancelled,
no_show

Response

Reminder updated