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

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

​
Authentication

Bearer token required. Scope: scheduling:write

​
Path parameters

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

​
Request body

All fields optional; at least one must be present.
FieldTypeDescription
scheduledAtUtcstringNew start time (ISO-8601 UTC). Triggers a rescheduled event and re-plans pending reminders.
assignedAgentIdstringReassign the call to a different agent. Triggers an assigned event.
guestNamestringUpdate guest display name.
guestPhonestring | nullUpdate or clear the guest phone.
guestEmailstring | nullUpdate or clear the guest email.
guestTimezonestringUpdate the guest’s IANA timezone.
guestIntakeNotesstringReplace intake notes.
reasonstringOptional free-text reason attached to the emitted event.
Each mutation emits its own event so the call timeline narrates what changed. Recurring series: this endpoint operates on a single instance in v1. Bulk edits require iteration.

​
Response

{
  "data": {
    "call": {
      "id": "uuid",
      "scheduled_at": "2026-05-02T16:00:00.000Z",
      "status": "scheduled"
    }
  }
}

​
Errors

  • 400 invalid_request no editable fields provided or payload invalid
  • 403 forbidden unauthorized for app or missing scope
  • 404 not_found call does not belong to this app
  • 409 conflict new slot unavailable, or call is already in a final state (cancelled / completed / no_show)
  • 429 rate_limit_exceeded
  • 500 server_error

​
Example

curl -X PATCH "https://api.apifycloud.io/api/v1/video/{appId}/scheduled-calls/{id}" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduledAtUtc": "2026-05-02T16:00:00.000Z",
    "reason": "Customer requested new time"
  }'