Delete webhook configuration

curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_delete' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30"}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_delete', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/webhooks_delete",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "deleted": true
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "webhooks_delete",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "webhooks_delete",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

POST

actions

webhooks_delete

curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_delete' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30"}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_delete', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/webhooks_delete",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "deleted": true
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "webhooks_delete",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "webhooks_delete",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

Remove your personal account’s webhook URL and signing secret.

POST https://api.voicecheap.ai/v1/actions/webhooks_delete

Authentication and permissions

string

required

Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint.

Required permissions: webhooks:write. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

string

Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.Format: “uuid”. Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.

Complete input schema

The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

{
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
    }
  },
  "additionalProperties": false
}

Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically. Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

curl --request POST 'https://api.voicecheap.ai/v1/actions/webhooks_delete' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30"}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/webhooks_delete', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/webhooks_delete",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. Confirms removal of the authenticated account’s webhook configuration.

{
  "data": {
    "deleted": true
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "webhooks_delete",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "webhooks_delete",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

Result fields

Field	Description
`data.deleted`	true after the webhook URL and signing secret are removed.

Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.

curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"webhooks_delete"}'

HTTP 200

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "webhooks_delete",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "deleted": true
    }
  }
}

Operation notes

Both the destination URL and signing secret are removed.

Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation’s own generation allowances also apply.

Errors

HTTP status	Code	Meaning or recovery
400	`BAD_REQUEST`	The authenticated account could not be found.
400	`CREDENTIAL_IN_QUERY`	Credentials were supplied in an access_token or api_key query parameter. Send credentials in headers.
400	`IDEMPOTENCY_CONFLICT`	The Idempotency-Key header and requestId body field must match.
400	`INVALID_REQUEST_ID`	Supply a UUID v4 requestId or Idempotency-Key.
400	`VALIDATION_ERROR`	The JSON object contains an unsupported field, an invalid value, or a missing required argument.
401	`API_KEY_EXPIRED`	The API key has expired.
401	`INVALID_API_KEY`	Provide a valid, unexpired API key.
401	`INVALID_CREDENTIAL`	The Authorization header is malformed or conflicts with x-api-key.
401	`MISSING_CREDENTIAL`	No usable header credential was supplied, or it exceeded 4096 characters.
401	`USER_NOT_FOUND`	The credential’s account no longer exists.
403	`ACCOUNT_UNAVAILABLE`	The acting or billing account is unavailable or being deleted.
403	`AMBIGUOUS_TEAM_API_KEY`	The credential’s user belongs to more than one team, so the billing context is ambiguous.
403	`INSUFFICIENT_SCOPE`	Grant every required permission or choose another credential.
403	`INTEGRATION_PLAN_UNSUPPORTED`	The account’s integration limits could not be verified.
403	`SUBSCRIPTION_REQUIRED`	Use an active paid subscription.
403	`TEAM_OWNER_NOT_FOUND`	The effective team owner account could not be found.
409	`CONCURRENT_ACTION_LIMIT_REACHED`	This account already has 10 integration actions running. Poll an existing request before starting another.
409	`IDEMPOTENCY_CONFLICT`	Reuse an identifier only with the same operation and arguments.
429	`INTEGRATION_MONTHLY_LIMIT_REACHED`	Wait for the monthly reset or change plan.
429	`INTEGRATION_RATE_LIMIT_REACHED`	Wait for Retry-After when present and use backoff.
500	`INTERNAL_ERROR`	Check saved request state and resource history before deciding to retry a mutation.
503	`ACTION_RESULT_UNAVAILABLE`	The action ran but its result could not be saved. Inspect saved request state and resource history before starting a new generation.
503	`SERVER_RESTARTING`	The server is restarting. Retry shortly and keep the same request identifier for a mutation.

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["webhooks:write"]
  }
}

Overview

Discovery

Account

Usage and activity

Settings and notifications

Team

Projects

Translation and dubbing

Transcripts and editing

Text to speech

Speech voices

Dubbing voices

Transcription

Subtitles and captions

Images

Thumbnails

Folders

Glossary

Webhooks

Publishing

Request status

OAuth and MCP protocol

Authentication and permissions

Parameters

Idempotency

Request examples

Response

Result fields

Recover and poll this request

Operation notes

Usage

Errors

​Authentication and permissions

​Parameters

​Idempotency

​Request examples

​Response

​Result fields

​Recover and poll this request

​Operation notes

​Usage

​Errors

Authentication and permissions

Parameters

Idempotency

Request examples

Response

Result fields

Recover and poll this request

Operation notes

Usage

Errors