Skip to main content
GET
Get campaign prompt

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

league_id
string
required

League containing the player's standing orders.

Pattern: ^league_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

player_id
string
required

Owned player whose standing orders should be returned.

Pattern: ^ply_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

player_id
string
required

Player whose standing orders are returned.

prompt
string
required

Standing orders currently used for campaign rounds.

is_default
boolean
required

Whether the league default is used because the player has no saved prompt.