Record SMS opt-ins from government customers.

When requesting a callback via API for a government organization, you can specify that a customer has opted in to receive SMS notifications.

In order to track that a customer has opted in to receive callback notifications, you can include an opt_ins property with API requests to Mindful Scheduler widget API endpoints.

See the example cURL request below:

curl --request POST \ 
--url 'https://<ORG_ID>.gov-scheduler-rt.getmindful.com/api/widget/<WIDGET_ID>/request_callback?time_zone=240' \ 
--header 'content-type: application/json' \ 
--data '{ "contact_number":"<PHONE_NUMBER>", "appointment_time":"<APPT_TIME>", "opt_ins": [ { "use_case": "callback-notifications", "channel": "sms", "timestamp": 1718372902847 } ] }'

To indicate that a customer has opted in to receive notifications, add the opt_ins property and specify an array of objects containing the following members:

• use_case — Assign the value callback-notifications.

• channel — Assign the value sms.

• timestamp — Provide a Unix-formatted time stamp to record the time the customer opted in.

When receiving a request to a Mindful Scheduler widget API endpoint that includes the opt_ins property, Mindful will assess whether the opt_ins object for the relevant use case and channel includes a timestamp property before proceeding with any SMS notifications configured for the relevant Call Target.

Initially, the only use_case and channel supported are callback-notifications and sms, respectively. For callback requests submitted via the widget API endpoint, callback notifications will only be sent by SMS for requests where either:

• The opt_ins object includes a timestamp, or...

• The opt_ins property is not present (for backwards compatibility)