Update Actions

Mutating endpoints that change linked-user fields or grant/revoke Discord roles.

GETupdateguildupdate

Add or remove a Discord role for one or more linked users. Calls Discord's REST API server-side using the bot token.

Parameters

id* (query)

string

Comma-separated Steam IDs.

mode* (query)

string

add or remove.

role* (query)

string

Discord role ID.

Response

"Roles updated"

GETupdateNitroguildupdate

Set the Nitro flag for a single linked user.

Parameters

id* (query)

string

Discord user ID.

status (query)

integer

1 or 0. Defaults to 0.

Response

"Nitro updated"

POSTupdateNitroBulkguildupdate

Set Nitro = 1 for every Discord ID in the body.

Request Body

{
  "discord_ids": ["349…", "123…"]
}

Response

{ "result": [] }

GETupdateSteamguildupdate

Update the cached Steam display name for a linked user.

Parameters

id* (query)

string

Steam 64 ID.

name* (query)

string

New Steam display name.

Response

"" // empty body, 200 OK

GETupdateOxideGroupsserverupdate

Set the Oxide/Carbon group list for a single Steam ID on this Server. Pass _none_ to clear.

Parameters

id* (query)

string

Steam 64 ID.

groups* (query)

string

Comma-separated group names, or _none_.

Response

"Oxide groups updated"

POSTupdateOxideGroupsBulkserverupdate

Bulk-set Oxide groups for many Steam IDs in one call.

Request Body

{
  "players": {
    "76561…001": ["vip", "trusted"],
    "76561…002": []
  }
}

Response

{ "updated": 2, "errors": 0 }