Edit a system alter

Edit a system alter by its ID. {user} can be @me to target the current OAuth user.

Authorization

oAuth2 alters:write

AuthorizationBearer <token>

OAuth 2.1 authentication

In: header

Scope: alters:write

Path Parameters

user*string

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

alter*string

{alter} is the alter ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Default{}

username?string

Match^[^\s@\\/]+$

Lengthlength <= 100

displayName?string

Lengthlength <= 100

nameMap?array<>

color?|

Match^#[0-9A-F]{6}$/i

description?|

Lengthlength <= 1000

pronouns?|

Lengthlength <= 100

avatarUrl?string|null

avatarUrlMap?

Default{}

webhookAvatarUrl?string|null

banner?string|null

alterMode?string

Default"webhook"

Value in

"nickname"
"webhook"
"both"

proxyTags?array<>

Default[]

tagIds?array<string>

Edit the tags associated with this alter. This will replace the list of tags inheriting this alter when using the API.

Default[]

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
VISIBILITY	`1` `(1 << 0)`	Allows external users to see the alter.
NAME	`2` `(1 << 1)`	Allows external users to see the alter's name.
DESCRIPTION	`4` `(1 << 2)`	Allows external users to see the alter's description.
BANNER	`8` `(1 << 3)`	Allows external users to see the alter's banner.
PRONOUNS	`16` `(1 << 4)`	Allows external users to see the alter's pronouns.
AVATAR	`32` `(1 << 5)`	Allows external users to see the alter's avatar.
TAGS	`128` `(1 << 7)`	Allows external users to see the alter's associated tags.
MESSAGE_COUNT	`256` `(1 << 8)`	Allows external users to see the alter's message count.
USERNAME	`512` `(1 << 9)`	Allows external users to see the alter's username.

Range0 <= value

Default0

flags?number

This is a bitwise operation-based number which determines which features are enabled.

Alter Flag	Value	Description
PROXY_TAGS_KEPT	`1` `(1 << 0)`	Keeps proxy tags after proxying for this specific alter.

Range0 <= value

Default0

fields?

Default{}

Response Body

`application/json`

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

{  "alterId": 0,  "systemId": "string",  "username": "string",  "displayName": "string",  "nameMap": [    {      "server": "string",      "name": "string"    }  ],  "color": "string",  "description": "string",  "created": "2019-08-24T14:15:22Z",  "pronouns": "string",  "avatarUrl": "string",  "avatarUrlMap": {},  "webhookAvatarUrl": "string",  "banner": "string",  "lastMessageTimestamp": "2019-08-24T14:15:22Z",  "messageCount": 0,  "alterMode": "nickname",  "proxyTags": [],  "tagIds": [],  "public": 0,  "flags": 0,  "fields": {}}

Edit a system alter

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`