Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

Disable one voice

Remove a single voice from the set donors can pick from: hide a TipPage voice, or drop another streamer’s voice you had added (whether or not it is still published). Your own cloned voices can’t be disabled, only deleted from the dashboard - 400 own_voice. There is no last-voice rule; turn the whole feature off with POST /ai-voices/disable. Requires ai_voices:manage. TipPage+: answers 404 unless AI voices are enabled for your account.

POST/ai-voices/{voiceId}/disable
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Path parameters
voiceIdstringrequired

The voice's id from GET /ai-voices.

Responses
200

The voice is disabled.

successboolean
idstring
enabledboolean
enabled_voicesinteger

How many voices the account offers after this change.

400

That is one of your own cloned voices - delete it from the dashboard instead.

errorstring
codestring
401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

required_scopestring
404

No such resource.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Parameters
Request
curl -X POST 'https://api.tippage.com/v1/ai-voices/string/disable' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "success": true,
  "id": "string",
  "enabled": false,
  "enabled_voices": 0
}