Ricky logorickyDocs

Preview appointment reminders

GET
/workflows/{workflow_id}/reminders/preview

Reads the Odoo appointments an appointment-reminder workflow would message on date and says, for each, whether it would be sent and with what text. Sends nothing. Only for workflows with source.kind odoo_appointments, in an organization with Odoo connected; past days are in the history.

Scope: workflows:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Path Parameters

workflow_id*string

Workflow ID.

Formatuuid

Query Parameters

date*string

Day the workflow would send, YYYY-MM-DD in its time zone: its next run or a later day.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
appointment_states?string

Odoo states to remind instead of the workflow’s, comma-separated, to see what a change would do. Omit it to use the workflow’s.

Length1 <= length <= 2000

Response Body

Success.

application/json
  1. response
data*

The Odoo appointments a reminder workflow would message on a coming day.

curl -X GET 'https://getricky.ai/api/v1/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/reminders/preview?date=2019-08-24'
{  "data": {    "date": "2026-10-20",    "timezone": "America/Panama",    "checked_at": "2026-10-14T15:30:00.000Z",    "appointment_states": [      {        "value": "confirmed",        "label": "Confirmada"      }    ],    "reminders": [      {        "appointment_id": "48213",        "appointment_state": "confirmed",        "customer_first_name": "Ana",        "phone": "+50760001234",        "branch_name": "Albrook Mall",        "starts_at": "2026-10-14T15:30:00.000Z",        "excluded_because": "state",        "message": "Hola Ana, te recordamos tu cita de mañana a las 10:00 en Albrook Mall.",        "delivery": {          "status": "pending",          "error": null        }      }    ]  }}