interviews

Cancel All Scheduled

Cancel all scheduled interviews for a campaign.

This will:

  1. Delete all Google Calendar events for scheduled contacts
  2. Cancel all pending interview jobs
  3. Reset all scheduled contacts to pending (can be rescheduled) or skipped

Use mark_as_skipped=true to permanently skip all contacts.

post/v1/interviews/{interview_id}/cancel-scheduled

Path parameters

interview_idstring uuid required

Headers

X-API-Keystring nullable

Request body

mark_as_skippedboolean

Response

Successful Response

cancelled_countinteger required
calendar_events_deletedinteger required
new_statusstring required
messagestring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.