Skip to content

Mark the caller as a contest winner

POST
/v1/calls/{call}/win
curl --request POST \
--url https://api.caller9.app/v1/calls/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/win \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "prize": "Concert tickets" }'

Records a contest win dated now for the caller’s contact (resolved by the caller’s number, creating the contact if needed). Each request records a new win; it is not idempotent. Wins count toward the studio’s contest eligibility window.

call
required
string format: uuid

Call ID (UUID).

Media typeapplication/json
object
prize

Optional prize description. Trimmed; longer values are truncated to 255 characters.

string
<= 255 characters

Example

{
"prize": "Concert tickets"
}

Win recorded.

Media typeapplication/json
object
ok
required
boolean
win
required
object
guid
required

Win record id.

string
won_at
required
string format: date-time
prize
required
string | null

Example

{
"ok": true
}

no caller number to record a win for

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

call not found — the call doesn’t exist, belongs to another organization, or has already ended (or, for reorder, call not found in queue).

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.