Update Scheduled Call

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.

Field	Type	Description
`scheduledAtUtc`	string	New start time (ISO-8601 UTC). Triggers a `rescheduled` event and re-plans pending reminders.
`assignedAgentId`	string	Reassign the call to a different agent. Triggers an `assigned` event.
`guestName`	string	Update guest display name.
`guestPhone`	string \| null	Update or clear the guest phone.
`guestEmail`	string \| null	Update or clear the guest email.
`guestTimezone`	string	Update the guest’s IANA timezone.
`guestIntakeNotes`	string	Replace intake notes.
`reason`	string	Optional 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"
  }'

API documentation

Authentication

Messaging

Video

Analytics

Endpoint

Authentication

Path parameters

Request body

Response

Errors

Example

​Endpoint

​Authentication

​Path parameters

​Request body

​Response

​Errors

​Example

Endpoint

Authentication

Path parameters

Request body

Response

Errors

Example