Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apifycloud.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

POST https://api.apifycloud.io/api/v1/video/{appId}/scheduled-calls/{id}/reminders

​
Authentication

Bearer token required. Scope: scheduling:write

​
Path parameters

  • appId (UUID, required)
  • id (UUID, required) — the scheduled call id

​
Request body

All fields optional.
FieldTypeDescription
kindstringDefaults to reminder_custom. Other accepted values match the lifecycle kinds (invitation, reminder_24h, reminder_1h, reminder_15m, cancellation).
channelstringv1 only dispatches whatsapp; the row inserts regardless.
recipientstringOverrides the recipient identifier. Falls back to the call’s guest_phone → guest_email.
The reminder is inserted with status='pending' and picked up by the scheduled-calls reminder cron on its next tick (~1 min cadence), bypassing the cron’s normal schedule.

​
Response

Returns 202 Accepted. 
{
  "data": {
    "reminder": {
      "id": "uuid",
      "fire_at": "2026-04-22T12:00:00.000Z",
      "reminder_kind": "reminder_custom",
      "channel": "whatsapp",
      "status": "pending"
    }
  }
}

​
Errors

  • 400 invalid_request unknown kind / channel or invalid payload
  • 403 forbidden unauthorized for app or missing scope
  • 404 not_found call does not belong to this app
  • 409 conflict call is in a final state and cannot receive reminders
  • 429 rate_limit_exceeded
  • 500 server_error

​
Example

curl -X POST "https://api.apifycloud.io/api/v1/video/{appId}/scheduled-calls/{id}/reminders" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "reminder_custom",
    "channel": "whatsapp",
    "recipient": "+57 300 555 0100"
  }'