Create a system

Create a system. {user} can be @me to target the current OAuth user. If there is already another system, this will fail.

Authorization

oAuth2 system:read

AuthorizationBearer <token>

OAuth 2.1 authentication

In: header

Scope: system:read

Path Parameters

user*string

{user} is a Discord user Snowflake, or @me, referencing the current OAuth user.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

systemName*string

Length1 <= length <= 100

systemDisplayTag?string|null

displayTagMap?

This is a map that shows the association between a Discord server ID and a custom display tag.

{   "1444187699924963350": "string"}

Default{}

systemDescription?string

Lengthlength <= 4000

systemAvatar?string|null

systemBanner?string|null

systemPronouns?string|null

nicknameFormat?string|null

latchExpiration?number

Range0 <= value <= 36000000

public?number

This is a bitwise operation-based number which determines the protection flags that are public. By default, everything on PluralBuddy is private.

Public Flag	Value	Description
NAME	`1` `(1 << 0)`	Allows external users to see system name.
DISPLAY_TAG	`2` `(1 << 1)`	Allows external users to see system display tag.
DESCRIPTION	`4` `(1 << 2)`	Allows external users to see system description.
AVATAR	`8` `(1 << 3)`	Allows external users to see system avatar.
BANNER	`16` `(1 << 4)`	Allows external users to see system banner.
PRONOUNS	`32` `(1 << 5)`	Allows external users to see system pronouns.
ALTERS	`64` `(1 << 6)`	Allows external users to see alters inside of the system.
TAGS	`128` `(1 << 7)`	Allows external users to see tags inside of the system.

Range0 <= value

flags?number

This is a bitwise operation-based number which determines certain system settings.

Public Flag	Value	Description
KEEP_PROXY_TAGS	`1` `(1 << 0)`	All messages sent in the system will maintain their proxy tags.
KEEP_PRONOUNS	`2` `(1 << 1)`	Pronouns will be shown in the webhook name of the proxying.
NO_TYPING_STATUS	`4` `(1 << 2)`	Typing status from the bot wont be displayed.
PREFER_ACCESSIBLITY	`8` `(1 << 3)`	Prefer accessiblity in menus for this system.
LEFT_SIDED_TAG	`16` `(1 << 4)`	Display tags will be displayed on the left side of the webhook.
CASE_INSENSITIVE_PROXIES	`32` `(1 << 5)`	Proxy tags when proxying will be matched case insensitively.
PUBLIC_DEFAULT	`64` `(1 << 6)`	All new objects in the system will automatically be created publicly.

Range0 <= value

Default0

disabledGuilds?array<string>

Default[]

disabled?boolean

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/v1/users/string/system" \  -H "Content-Type: application/json" \  -d '{    "systemName": "string"  }'

{  "associatedUserId": "string",  "systemName": "string",  "systemDisplayTag": "string",  "displayTagMap": {},  "systemDescription": "string",  "systemAvatar": "string",  "systemBanner": "string",  "systemPronouns": "string",  "nicknameFormat": "string",  "alterIds": [],  "tagIds": [],  "createdAt": "2019-08-24T14:15:22Z",  "systemAutoproxy": [    {      "autoproxyMode": "off",      "autoproxyAlter": "string",      "serverId": "string",      "lastLatchTimestamp": "2019-08-24T14:15:22Z"    }  ],  "systemOperationDM": true,  "latchExpiration": 0,  "public": 0,  "flags": 0,  "disabledGuilds": [],  "subAccounts": [],  "disabled": false}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`