Skip to content

Delete a custom contest prompt

DELETE
/v1/studios/{studio}/contest-prompt
curl --request DELETE \
--url 'https://api.caller9.app/v1/studios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contest-prompt?kind=caller' \
--header 'Authorization: Bearer <token>'

Removes the override for one prompt slot, reverting it to the platform default. Succeeds even if no override exists. Requires a full-access key.

studio
required
string format: uuid

Studio ID (UUID).

kind
required
string
Allowed values: caller pre loser

Prompt slot — pre (pre-contest message), loser (non-winning callers), or caller (announcement for a specific caller number).

number
integer
>= 1 <= 109

Caller number for kind=caller (required then); ignored otherwise.

Prompt removed (or none existed).

Media typeapplication/json
object
ok
required
boolean

Example

{
"ok": true
}

The request was invalid.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

The key isn’t allowed to do this (e.g. a read-only key making a change).

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.