Adds an invite.

POST

/v1/invite

invite

Adds an invite to a ladder or tournament. Either ladderId or tournamentId needs to be specified.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

ladderId

array[integer]

optional

Id of the ladder to create an invite for.

tournamentId

array[integer]

optional

Id of the tournament to create an invite for. Currently unused.

uses

array[integer]

optional

Amount of uses before this invite expires automatically.

teamInvite

array[integer]

optional

Whether this invite should be a "team invite" where all accounts accepting the same invite act as a single ladder-entry in a competition. This is useful if you intend to rate a team constellation as a whole, instead of each player by themselves. Creating a team invite will simultaneously create the preliminary team-ladder-entry, contrary to normal invites which create ladder-entries upon accepting them instead of creating them.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

string

required

References an invite and forms an invite link for use through the Competier App.

Example:

HHLCdISYcyU=

ladderId

integer

optional

Which ladder this invites to.

Example:

tournamentId

integer

optional

Which tournament this invites to.

Example:

uses

integer

optional

How many uses are left for this invite (if it's use-limited).

Example:

100

teamLadderEntryId

integer

optional

Which ladder-entry id this invites to. This allows for "team invites" where all accounts accepting the same invite act as a single ladder-entry in a competition. This is useful if you intend to rate a team constellation as a whole, instead of each player by themselves.

Example

{
    "code": "HHLCdISYcyU=",
    "ladderId": 0,
    "tournamentId": 0,
    "uses": 100,
    "teamLadderEntryId": 0
}

🟠400Bad request

🟠401Unauthorized

🟠429Too Many Requests

Modified at 2024-04-09 16:58:35

Gets game results.

Accepts an invite.