Video Intros

Cancel a Video Intro

POST/v1/video-intros/{id}/cancel

For a cancelled or rescheduled appointment. A Video Intro that was already sent stays sent; one that was not is stopped and its links stop working.

Authentication

A bearer API key. Authentication.

Headers

Authorizationstringrequired
Bearer followed by your API key. A test key works in the test environment only.
Idempotency-Keystringrequired
A value that is the same every time you send THIS event, and different for every other event.

Path parameters

idstringrequired
The Video Intro's identifier.

Errors

Status	Code	When
401	`unauthorized`	The API key is missing, malformed or revoked.
404	`not_found`	No such object in this organization and environment.
409	`idempotency_conflict`	This Idempotency-Key was already used with a different body.

All errors

Request

curl -X POST https://api.videointros.com/v1/video-intros/vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10/cancel \
  -H "Authorization: Bearer $VIDEO_INTROS_API_KEY" \
  -H "Idempotency-Key: your_crm:appointment_123:cancel"

const response = await fetch("https://api.videointros.com/v1/video-intros/vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VIDEO_INTROS_API_KEY}`,
    "Idempotency-Key": "your_crm:appointment_123:cancel",
  },
});
const result = await response.json();

import os, requests

response = requests.post(
    "https://api.videointros.com/v1/video-intros/vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10/cancel",
    headers={
        "Authorization": f"Bearer {os.environ['VIDEO_INTROS_API_KEY']}",
        "Idempotency-Key": "your_crm:appointment_123:cancel",
    },
)
result = response.json()

Response · 200

{
  "id": "vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10",
  "object": "video_intro",
  "status": "cancelled",
  "touchpoint": null,
  "member": {
    "id": "mem_3f9a1c27",
    "external_id": "rep_456",
    "first_name": "Anthony",
    "last_name": "Baker"
  },
  "recipient": {
    "first_name": "Andrea",
    "last_name": "Smith",
    "phone": "+12405550100"
  },
  "reference": {
    "source": "your_app",
    "type": "order",
    "id": "order_981"
  },
  "delivery": {
    "responsibility": "integration",
    "recipient_url": null
  },
  "metadata": {
    "order_id": "order_981"
  },
  "environment": "test",
  "created_at": "2026-10-05T17:40:01Z"
}

An error

{
  "error": {
    "code": "not_found",
    "message": "No such object in this organization and environment."
  }
}