Skip to content

Arm a contest

POST
/v1/studios/{studio}/contest
curl --request POST \
--url https://api.caller9.app/v1/studios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "target": 1, "backups": 1, "postTimeoutSecs": 1 }'

Arms Contest Mode in the pre-contest phase. Each parameter falls back to the studio’s saved default (contest_target, contest_backups, contest_post_timeout_secs). The studio must have contest_enabled. While a contest is armed it takes precedence over AI screening. The body is optional.

studio
required
string format: uuid

Studio ID (UUID).

Media typeapplication/json
object
target

Winning caller number.

integer
>= 1 <= 110
backups

Number of backup winners.

integer
<= 100
postTimeoutSecs

Length of the post-contest window, in seconds.

integer
>= 10 <= 3600

Example generated

{
"target": 1,
"backups": 1,
"postTimeoutSecs": 1
}

Contest armed.

Media typeapplication/json
object
ok
required
boolean
phase
required
string
Allowed value: pre
target
required
integer
backups
required
integer
post_timeout_secs
required
integer

Example

{
"ok": true,
"phase": "pre"
}

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"
}

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"
}

Contest Mode is not enabled for this studio.

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.