FLflagpost
Reminders

Create Reminder

Create a new reminder schedule.

Args: business_id: Business UUID request: Reminder configuration ctx: Advisor context

Returns: Created reminder

post/api/businesses/{business_id}/reminders

Request

  • Base URL
    https://api.flagpost.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

business_idstring required

Request body

reminder_typestring required
recipient_emailstring required
recipient_namestring nullable
subjectstring required
messagestring required
schedule_typestring required
scheduled_datestring date-time nullable
recurrence_patternstring nullable
recurrence_intervalinteger
max_sendsinteger nullable

Response

Successful Response

idstring required
business_idstring required
reminder_typestring required
recipient_emailstring required
recipient_namestring nullable required
subjectstring required
messagestring required
schedule_typestring required
scheduled_datestring date-time nullable required
recurrence_patternstring nullable required
recurrence_intervalinteger required
next_send_datestring date-time required
last_sent_datestring date-time nullable required
is_activeboolean required
send_countinteger required
max_sendsinteger nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.