Create an invite link

POST

/v1/communities/{id}/invites

curl --request POST \
  --url https://api.gampeon.com/v1/communities/1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "maxUses": 1, "expiresInDays": 1 }'

• Production

Needs createInvites. Links last 1 to 30 days (default 7). maxUses 0 means no limit. Share https://gampeon.com/invite/<code> once the launcher handles invite links.

Not available with access tokens.

Rate limit: 20 per hour per account.

Authorizations

• session

Parameters

Path Parameters

id

required

integer

>= 1

Community ID

Request Body^required

Media typeapplication/json

object

maxUses

integer

<= 1000

expiresInDays

integer

>= 1 <= 30

Example ^generated

{
  "maxUses": 1,
  "expiresInDays": 1
}

Responses

201

Invite

Media typeapplication/json

object

code

required

string

maxUses

required

integer

uses

required

integer

expiresAt

required

Unix time in milliseconds

integer format: int64

Example ^generated

{
  "code": "example",
  "maxUses": 1,
  "uses": 1,
  "expiresAt": 1
}

400

Error codes: invalid_field

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

401

Error codes: unauthorized

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: token_not_allowed, missing_permission

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

409

Error codes: invite_limit_reached

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

429

Limit: 20 per hour per account. Error codes: rate_limited

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}