PluralKit API

https://pluralkit.me/api
Admin
PluralKit API is a HTTP REST API for querying and modifying plural systems, enabling management of...
Tokens:10,137
Snippets:92
Trust Score:9.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Switch

Source: https://pluralkit.me/api/endpoints

Retrieves a specific switch by its reference for a given system.

```APIDOC
## GET `/systems/{systemRef}/switches/{switchRef}`

### Description
Retrieves a specific switch identified by `switchRef` for the given system. Returns a switch object containing a list of member objects.

### Method
GET

### Endpoint
`/systems/{systemRef}/switches/{switchRef}`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - The reference of the system (UUID, short ID, linked Discord ID, or `@me`).
- **switchRef** (string) - Required - The reference of the switch (UUID).

### Response
#### Success Response (200)
- **switch** (switch object) - The requested switch object, containing a list of member objects.

#### Response Example
```json
{
  "switch": {
    "id": "switch_uuid_1",
    "timestamp": "2023-10-27T10:00:00Z",
    "members": [
      {
        "id": "member_uuid_1",
        "uuid": "member_uuid_1",
        "username": "Member One",
        "display_name": "Member One",
        "avatar_url": "https://example.com/avatar.png"
      }
    ]
  }
}
```
```

--------------------------------

### Get Current System Fronters

Source: https://pluralkit.me/api/endpoints

Retrieves the current fronters for a given system.

```APIDOC
## GET `/systems/{systemRef}/fronters`

### Description
Retrieves the current fronters for a specified system. If the system has no registered switches, a 204 No Content status is returned.

### Method
GET

### Endpoint
`/systems/{systemRef}/fronters`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - The reference of the system (UUID, short ID, linked Discord ID, or `@me`).

### Response
#### Success Response (200)
- **fronters** (array of member objects) - A list of member objects representing the current fronters.
#### Success Response (204)
No Content if the system has no registered switches.

#### Response Example
```json
{
  "fronters": [
    {
      "id": "member_uuid_1",
      "uuid": "member_uuid_1",
      "username": "Member One",
      "display_name": "Member One",
      "avatar_url": "https://example.com/avatar.png"
    }
  ]
}
```
```

--------------------------------

### Rate Limiting Response Example

Source: https://pluralkit.me/api

Example JSON response when the API rate limits are exceeded.

```APIDOC
{
  "message": "429: too many requests",
  "retry_after": 19, 
  "code": 0
}
```

--------------------------------

### Get System Switches

Source: https://pluralkit.me/api/endpoints

Retrieves a list of switches associated with a given system, with optional pagination.

```APIDOC
## GET `/systems/{systemRef}/switches`

### Description
Retrieves a list of switches for a given system. Supports pagination using the `before` parameter and limits the number of results with the `limit` parameter. Returns at most 100 switches per request.

### Method
GET

### Endpoint
`/systems/{systemRef}/switches`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - The reference of the system (UUID, short ID, linked Discord ID, or `@me`).

#### Query Parameters
- **before** (timestamp) - Optional - Date to get the latest switch from for pagination.
- **limit** (int) - Optional - Number of switches to retrieve (defaults to 100).

### Response
#### Success Response (200)
- **switches** (array of switch objects) - A list of switch objects.

#### Response Example
```json
{
  "switches": [
    {
      "id": "switch_uuid_1",
      "timestamp": "2023-10-27T10:00:00Z",
      "members": ["member_uuid_1", "member_uuid_2"]
    }
  ]
}
```
```

--------------------------------

### Authorization Header Example

Source: https://pluralkit.me/api

Pass your system token in the Authorization HTTP header for authenticated requests. Failure to do so on protected endpoints will result in a 401 Unauthorized error.

```http
Authorization: z865MC7JNhLtZuSq1NXQYVe+FgZJHBfeBCXOPYYRwH4liDCDrsd7zdOuR45mX257
```

--------------------------------

### Get System Guild Settings

Source: https://pluralkit.me/api/endpoints

Retrieves the guild-specific settings for the authenticated system. Requires prior update of per-guild settings.

```APIDOC
## Get System Guild Settings

### Description
Returns a system guild settings object.
TIP
You must already have updated per-guild settings for your system in the target guild before being able to get or update them from the API.

### Method
GET

### Endpoint
`/systems/@me/guilds/{guild_id}`

### Parameters
#### Path Parameters
- **guild_id** (snowflake) - Required - The ID of the guild.

### Note
This endpoint specifically uses `@me` to refer to the currently authenticated system.
```

--------------------------------

### Get System Settings

Source: https://pluralkit.me/api/endpoints

Retrieves the settings for a specific system. If not authenticated or authenticated as a different system, it returns public settings. The system reference can be a short ID, UUID, linked Discord account ID, or '@me' for the authenticated system.

```APIDOC
## Get System Settings

### Description
Returns a system settings object.
If not authenticated, or authenticated as a different system, returns a public system settings object.

### Method
GET

### Endpoint
`/systems/{systemRef}/settings`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - Can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.
```

--------------------------------

### Get System Autoproxy Settings

Source: https://pluralkit.me/api/endpoints

Retrieves the autoproxy settings for the authenticated system. Supports filtering by guild ID. Currently, only guild-based autoproxy is supported.

```APIDOC
## Get System Autoproxy Settings

### Description
Returns an autoproxy settings object on success.
WARNING
Currently, only autoproxy with `guild_id` is supported. The API will return an error message if you specify `channel_id`, or do not specify a `guild_id`.

### Method
GET

### Endpoint
`/systems/@me/autoproxy`

### Parameters
#### Query Parameters
- **guild_id** (snowflake) - Optional - The ID of the guild to filter autoproxy settings.
- **channel_id** (snowflake) - Optional - The ID of the channel to filter autoproxy settings (currently not supported).

### Note
This endpoint specifically uses `@me` to refer to the currently authenticated system.
```

--------------------------------

### Get System

Source: https://pluralkit.me/api/endpoints

Retrieves a system object using a system reference. The system reference can be a short ID, UUID, linked Discord account ID, or '@me' for the authenticated system.

```APIDOC
## Get System

### Description
Returns a system object.

### Method
GET

### Endpoint
`/systems/{systemRef}`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - Can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.
```

--------------------------------

### Get System Groups

Source: https://pluralkit.me/api/endpoints

Retrieves a list of group objects for a given system. The system reference can be a short ID, UUID, linked Discord account ID, or '@me' for the authenticated system. Optionally includes members in the response.

```APIDOC
## Get System Groups

### Description
Returns a list of group objects.

### Method
GET

### Endpoint
`/systems/{systemRef}/groups`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - Can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.

#### Query Parameters
- **with_members** (boolean) - Optional - Includes `members` key with array of member UUIDs in each group object.
```

--------------------------------

### Get System Members

Source: https://pluralkit.me/api/endpoints

Retrieves a list of member objects associated with a given system. The system reference can be a short ID, UUID, linked Discord account ID, or '@me' for the authenticated system.

```APIDOC
## Get System Members

### Description
Returns a list of member objects.

### Method
GET

### Endpoint
`/systems/{systemRef}/members`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - Can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.
```

--------------------------------

### Get Group

Source: https://pluralkit.me/api/endpoints

Retrieves a specific group object using a group reference. The group reference can be a short ID or UUID.

```APIDOC
## Get Group

### Description
Returns a group object.

### Method
GET

### Endpoint
`/groups/{groupRef}`

### Parameters
#### Path Parameters
- **groupRef** (string) - Required - Can be a group's short (5 or 6 character ID) or a group's UUID.
```

--------------------------------

### Get Member

Source: https://pluralkit.me/api/endpoints

Retrieves a specific member object using a member reference. The member reference can be a short ID or UUID.

```APIDOC
## Get Member

### Description
Returns a member object.

### Method
GET

### Endpoint
`/members/{memberRef}`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.
```

--------------------------------

### Get Group Members

Source: https://pluralkit.me/api/endpoints

Retrieves a list of member objects that belong to a specific group. The group reference can be a short ID or UUID.

```APIDOC
## Get Group Members

### Description
Returns an array of member objects.

### Method
GET

### Endpoint
`/groups/{groupRef}/members`

### Parameters
#### Path Parameters
- **groupRef** (string) - Required - Can be a group's short (5 or 6 character ID) or a group's UUID.
```

--------------------------------

### Get Member Guild Settings

Source: https://pluralkit.me/api/endpoints

Retrieves the guild-specific settings for a specific member. The member reference can be a short ID or UUID. Requires prior update of per-guild settings for the target member.

```APIDOC
## Get Member Guild Settings

### Description
Returns a member guild settings object.
TIP
You must already have updated per-guild settings for the target member in the target guild before being able to get or update them from the API.

### Method
GET

### Endpoint
`/members/{memberRef}/guilds/{guild_id}`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.
- **guild_id** (snowflake) - Required - The ID of the guild.
```

--------------------------------

### Get Member Groups

Source: https://pluralkit.me/api/endpoints

Retrieves a list of group objects that a specific member belongs to. The member reference can be a short ID or UUID.

```APIDOC
## Get Member Groups

### Description
Returns an array of group objects.

### Method
GET

### Endpoint
`/members/{memberRef}/groups`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.
```

--------------------------------

### Get Proxied Message Information

Source: https://pluralkit.me/api/endpoints

Retrieves information about a proxied message using its ID. This lookup is only effective for messages sent within the last 30 minutes.

```APIDOC
## GET `/messages/{message}`

### Description
Retrieves information about a proxied message. The `message` parameter can be the ID of a proxied message or the ID of the message that initiated the proxy. Note that looking up by the original message ID is only supported for up to 30 minutes after the message was sent.

### Method
GET

### Endpoint
`/messages/{message}`

### Parameters
#### Path Parameters
- **message** (string) - Required - The ID of the proxied message or the original message.

### Response
#### Success Response (200)
- **message** (message object) - A message object containing details about the proxied message.

#### Response Example
```json
{
  "message": {
    "id": "proxied_message_id",
    "channel_id": "channel_id",
    "author": {
      "id": "member_uuid_1",
      "uuid": "member_uuid_1",
      "username": "Member One",
      "display_name": "Member One"
    },
    "content": "This is a proxied message.",
    "timestamp": "2023-10-27T12:00:00Z"
  }
}
```
```

--------------------------------

### Create Switch

Source: https://pluralkit.me/api/endpoints

Creates a new switch for a system, optionally specifying the timestamp and members.

```APIDOC
## POST `/systems/{systemRef}/switches`

### Description
Creates a new switch for the specified system. You can provide a specific timestamp for when the switch started and a list of members in the switch. If `timestamp` is omitted, it defaults to the current time.

### Method
POST

### Endpoint
`/systems/{systemRef}/switches`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - The reference of the system (UUID, short ID, linked Discord ID, or `@me`).

#### Request Body
- **timestamp** (datetime) - Optional - When the switch started. Defaults to "now" when missing.
- **members** (list of strings) - Optional - Members present in the switch (or an empty list for a switch-out). Can be short IDs or UUIDs.

### Response
#### Success Response (200)
- **switch** (switch object) - The newly created switch object, containing a list of member objects.

#### Response Example
```json
{
  "switch": {
    "id": "new_switch_uuid",
    "timestamp": "2023-10-27T10:30:00Z",
    "members": [
      {
        "id": "member_uuid_1",
        "uuid": "member_uuid_1",
        "username": "Member One",
        "display_name": "Member One",
        "avatar_url": "https://example.com/avatar.png"
      }
    ]
  }
}
```
```

--------------------------------

### Update System Settings

Source: https://pluralkit.me/api/endpoints

Updates the settings for a specific system with partial data. The system reference can be a short ID, UUID, linked Discord account ID, or '@me' for the authenticated system.

```APIDOC
## Update System Settings

### Description
Takes a partial system settings object.
Returns a system settings object.

### Method
PATCH

### Endpoint
`/systems/{systemRef}/settings`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - Can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.

#### Request Body
- (object) - Optional - Partial system settings object.
```

--------------------------------

### Update System Autoproxy Settings

Source: https://pluralkit.me/api/endpoints

Updates the autoproxy settings for the authenticated system with partial data. Supports filtering by guild ID. Currently, only guild-based autoproxy is supported.

```APIDOC
## Update System Autoproxy Settings

### Description
Takes a partial autoproxy settings object.
Returns an autoproxy settings object on success.
WARNING
Currently, only autoproxy with `guild_id` is supported. The API will return an error message if you specify `channel_id`, or do not specify a `guild_id`.

### Method
PATCH

### Endpoint
`/systems/@me/autoproxy`

### Parameters
#### Query Parameters
- **guild_id** (snowflake) - Optional - The ID of the guild to filter autoproxy settings.
- **channel_id** (snowflake) - Optional - The ID of the channel to filter autoproxy settings (currently not supported).

#### Request Body
- (object) - Optional - Partial autoproxy settings object.

### Note
This endpoint specifically uses `@me` to refer to the currently authenticated system.
```

--------------------------------

### Create Member

Source: https://pluralkit.me/api/endpoints

Creates a new member object. The 'name' field is required in the input.

```APIDOC
## Create Member

### Description
Takes a partial member object as input. Key `name` is required.
Returns a member object on success.

### Method
POST

### Endpoint
`/members`

### Request Body
- **name** (string) - Required - The name of the member.
- (object) - Optional - Other partial member object fields.
```

--------------------------------

### Update System

Source: https://pluralkit.me/api/endpoints

Updates a system object with partial data. The system reference can be a short ID, UUID, linked Discord account ID, or '@me' for the authenticated system.

```APIDOC
## Update System

### Description
Takes a partial system object.
Returns a system object.

### Method
PATCH

### Endpoint
`/systems/{systemRef}`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - Can be a system's short (5 or 6 character) ID, a system's UUID, the ID of a Discord account linked to the system, or the string `@me` to refer to the currently authenticated system.

#### Request Body
- (object) - Optional - Partial system object.
```

--------------------------------

### Update System Guild Settings

Source: https://pluralkit.me/api/endpoints

Updates the guild-specific settings for the authenticated system with partial data. Requires prior update of per-guild settings.

```APIDOC
## Update System Guild Settings

### Description
Takes a partial system guild settings object.
Returns a system guild settings object on success.

### Method
PATCH

### Endpoint
`/systems/@me/guilds/{guild_id}`

### Parameters
#### Path Parameters
- **guild_id** (snowflake) - Required - The ID of the guild.

#### Request Body
- (object) - Optional - Partial system guild settings object.

### Note
This endpoint specifically uses `@me` to refer to the currently authenticated system.
```

--------------------------------

### Add Member To Groups

Source: https://pluralkit.me/api/endpoints

Adds a member to one or more groups. Takes a list of group references as input. Returns 204 No Content on success.

```APIDOC
## Add Member To Groups

### Description
Takes a list of group references as input. Returns 204 No Content on success.

### Method
POST

### Endpoint
`/members/{memberRef}/groups/add`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.

#### Request Body
- (array) - Required - List of group references.
```

--------------------------------

### Create Group

Source: https://pluralkit.me/api/endpoints

Creates a new group object. The 'name' field is required in the input. Returns the created group object on success or an error object on failure.

```APIDOC
## Create Group

### Description
Takes a partial group object as input. Key `name` is required.
Returns a group object on success, or an error object on failure.

### Method
POST

### Endpoint
`/groups`

### Request Body
- **name** (string) - Required - The name of the group.
- (object) - Optional - Other partial group object fields.
```

--------------------------------

### Add Members To Group

Source: https://pluralkit.me/api/endpoints

Adds one or more members to a specific group. Takes an array of member references as input. Returns 204 No Content on success.

```APIDOC
## Add Members To Group

### Description
Takes an array of member references as input. Returns 204 No Content on success.

### Method
POST

### Endpoint
`/groups/{groupRef}/members/add`

### Parameters
#### Path Parameters
- **groupRef** (string) - Required - Can be a group's short (5 or 6 character ID) or a group's UUID.

#### Request Body
- (array) - Required - Array of member references.
```

--------------------------------

### Update Switch

Source: https://pluralkit.me/api/endpoints

Updates an existing switch for a system, allowing modification of the timestamp.

```APIDOC
## PATCH `/systems/{systemRef}/switches/{switchRef}`

### Description
Updates an existing switch for the specified system. Currently, only the `timestamp` can be modified.

### Method
PATCH

### Endpoint
`/systems/{systemRef}/switches/{switchRef}`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - The reference of the system (UUID, short ID, linked Discord ID, or `@me`).
- **switchRef** (string) - Required - The reference of the switch (UUID) to update.

#### Request Body
- **timestamp** (datetime) - Required - The new timestamp for when the switch started.

### Response
#### Success Response (200)
- **switch** (switch object) - The updated switch object, containing a list of member objects.

#### Response Example
```json
{
  "switch": {
    "id": "switch_uuid_1",
    "timestamp": "2023-10-27T11:00:00Z",
    "members": [
      {
        "id": "member_uuid_1",
        "uuid": "member_uuid_1",
        "username": "Member One",
        "display_name": "Member One",
        "avatar_url": "https://example.com/avatar.png"
      }
    ]
  }
}
```
```

--------------------------------

### Overwrite Member Groups

Source: https://pluralkit.me/api/endpoints

Replaces all existing group memberships for a member with a new list of groups. Takes a list of group references as input. An empty list is accepted. Returns 204 No Content on success.

```APIDOC
## Overwrite Member Groups

### Description
Takes a list of group references as input. (An empty list is accepted.) Returns 204 No Content on success.

### Method
POST

### Endpoint
`/members/{memberRef}/groups/overwrite`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.

#### Request Body
- (array) - Required - List of group references.
```

--------------------------------

### Update Member Guild Settings

Source: https://pluralkit.me/api/endpoints

Updates the guild-specific settings for a specific member with partial data. The member reference can be a short ID or UUID. Requires prior update of per-guild settings for the target member.

```APIDOC
## Update Member Guild Settings

### Description
Takes a partial member guild settings object.
Returns a member guild settings object on success.

### Method
PATCH

### Endpoint
`/members/{memberRef}/guilds/{guild_id}`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.
- **guild_id** (snowflake) - Required - The ID of the guild.

#### Request Body
- (object) - Optional - Partial member guild settings object.
```

--------------------------------

### Update Switch Members

Source: https://pluralkit.me/api/endpoints

Updates the list of members for a specific switch.

```APIDOC
## PATCH `/systems/{systemRef}/switches/{switchRef}/members`

### Description
Updates the list of members for a specific switch. This replaces the existing member list with the provided list.

### Method
PATCH

### Endpoint
`/systems/{systemRef}/switches/{switchRef}/members`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - The reference of the system (UUID, short ID, linked Discord ID, or `@me`).
- **switchRef** (string) - Required - The reference of the switch (UUID) whose members are to be updated.

#### Request Body
- **members** (list of strings) - Required - A list of member short IDs or UUIDs to set as the switch's members.

### Response
#### Success Response (200)
- **switch** (switch object) - The updated switch object, containing the new list of member objects.

#### Response Example
```json
{
  "switch": {
    "id": "switch_uuid_1",
    "timestamp": "2023-10-27T10:00:00Z",
    "members": [
      {
        "id": "member_uuid_1",
        "uuid": "member_uuid_1",
        "username": "Member One",
        "display_name": "Member One",
        "avatar_url": "https://example.com/avatar.png"
      },
      {
        "id": "member_uuid_3",
        "uuid": "member_uuid_3",
        "username": "Member Three",
        "display_name": "Member Three",
        "avatar_url": "https://example.com/avatar3.png"
      }
    ]
  }
}
```
```

--------------------------------

### Delete Switch

Source: https://pluralkit.me/api/endpoints

Deletes a specific switch from a system.

```APIDOC
## DELETE `/systems/{systemRef}/switches/{switchRef}`

### Description
Deletes a specific switch identified by `switchRef` from the given system.

### Method
DELETE

### Endpoint
`/systems/{systemRef}/switches/{switchRef}`

### Parameters
#### Path Parameters
- **systemRef** (string) - Required - The reference of the system (UUID, short ID, linked Discord ID, or `@me`).
- **switchRef** (string) - Required - The reference of the switch (UUID) to delete.

### Response
#### Success Response (204)
No Content on success.
```

--------------------------------

### JSON Error Codes

Source: https://pluralkit.me/api/errors

A comprehensive list of numerical error codes returned by the PluralKit API, along with their associated HTTP response codes and meanings. This helps in understanding the nature of the error and how to address it.

```APIDOC
## JSON error codes

code | HTTP response code | meaning  
---|---|---  
0 | 500 | Internal server error, try again later  
0 | 400 | Invalid JSON, or invalid request format (check `error` key in the response body)  
0 | 401 | Missing or invalid Authorization header  
0 | 403 | Your access to the API is blocked - please contact us in the support server  
20001 | 404 | System not found.  
20002 | 404 | Member not found.  
20003 | 404 | Member '{memberRef}' not found.  
20004 | 404 | Group not found.  
20005 | 404 | Group '{groupRef}' not found.  
20006 | 404 | Message not found.  
20007 | 404 | Switch not found.  
20008 | 404 | Switch not found, switch associated with different system, or unauthorized to view front history.  
20009 | 404 | No system guild settings found for target guild.  
20010 | 404 | No member guild settings found for target guild.  
30001 | 403 | Unauthorized to view member list  
30002 | 403 | Unauthorized to view group list  
30003 | 403 | Unauthorized to view group member list  
30004 | 403 | Unauthorized to view current fronters.  
30005 | 403 | Unauthorized to view front history.  
30006 | 403 | Target member is not part of your system.  
30007 | 403 | Target group is not part of your system.  
30008 | 403 | Member '{memberRef}' is not part of your system.  
30009 | 403 | Group '{groupRef}' is not part of your system.  
40001 | 400 | Error parsing JSON model (check `errors` key for details)  
40002 | 400 | Missing autoproxy member for member-mode autoproxy.  
40003 | 400 | Duplicate members in member list.  
40004 | 400 | Member list identical to current fronter list.  
40005 | 400 | Switch with provided timestamp already exists.  
40006 | 400 | Invalid switch ID.
```

--------------------------------

### Error Object

Source: https://pluralkit.me/api/errors

When the `errors` key is present in the error response, it contains a map of entity keys to a list of error objects. Each error object provides a specific error description and may include additional details like maximum and actual lengths for validation errors.

```APIDOC
## Error Object

key | type | description  
---|---|---  
message | string | error description  
?max_length | int | if this is an error indicating a key is too long, the maximum allowed length for the key  
?actual_length | int | if this is an error indicating a key is too long, the length of the provided value
```

--------------------------------

### Delete Group

Source: https://pluralkit.me/api/endpoints

Deletes a specific group. Returns 204 No Content on success.

```APIDOC
## Delete Group

### Description
Returns 204 No Content on success.

### Method
DELETE

### Endpoint
`/groups/{groupRef}`

### Parameters
#### Path Parameters
- **groupRef** (string) - Required - Can be a group's short (5 or 6 character ID) or a group's UUID.
```

--------------------------------

### Error Response Model

Source: https://pluralkit.me/api/errors

The PluralKit API returns a JSON object describing the error when a 4xx HTTP status code is encountered. This object includes a numerical error code, a descriptive message, and optionally, details on specific errors or retry information.

```APIDOC
## Error Response Model

key | type | description  
---|---|---  
code | int | numerical error code  
message | string | description of the error  
?errors | map of entity keys to list of error objects* | details on the error  
?retry_after | int | if this is a rate limit error, the number of milliseconds after which you can retry the request  
  * Only returned for model parsing errors.
```

--------------------------------

### Overwrite Group Members

Source: https://pluralkit.me/api/endpoints

Replaces all members of a group with a new list of members. An empty list can be provided to remove all members.

```APIDOC
## POST `/groups/{groupRef}/members/overwrite`

### Description
Replaces all members of a specified group with the provided list of member references. An empty list is accepted to remove all members.

### Method
POST

### Endpoint
`/groups/{groupRef}/members/overwrite`

### Parameters
#### Path Parameters
- **groupRef** (string) - Required - The reference of the group to overwrite members for.

#### Request Body
- **members** (array of strings) - Required - A list of member references to set as the group's members. Can be an empty list.

### Response
#### Success Response (204)
No Content on success.
```

--------------------------------

### Delete Member

Source: https://pluralkit.me/api/endpoints

Deletes a specific member. Returns 204 No Content on success.

```APIDOC
## Delete Member

### Description
Returns 204 No Content on success.

### Method
DELETE

### Endpoint
`/members/{memberRef}`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.
```

--------------------------------

### Update Member

Source: https://pluralkit.me/api/endpoints

Updates a specific member object with partial data. The member reference can be a short ID or UUID.

```APIDOC
## Update Member

### Description
Takes a partial member object as input.
Returns a member object on success.

### Method
PATCH

### Endpoint
`/members/{memberRef}`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.

#### Request Body
- (object) - Optional - Partial member object.
```

--------------------------------

### Rate Limit Exceeded Response

Source: https://pluralkit.me/api

When rate limits are exceeded, the API will respond with a 429 status code and a JSON body indicating the error and the time to wait before retrying.

```json
{
  "message": "429: too many requests",
  "retry_after": 19, // the amount of milliseconds remaining until you can make more requests
  "code": 0
}
```

--------------------------------

### Update Group

Source: https://pluralkit.me/api/endpoints

Updates a specific group object with partial data. The group reference can be a short ID or UUID. Returns the updated group object on success or an error object on failure.

```APIDOC
## Update Group

### Description
Takes a partial group object as input.
Returns a group object on success, or an error object on failure.

### Method
PATCH

### Endpoint
`/groups/{groupRef}`

### Parameters
#### Path Parameters
- **groupRef** (string) - Required - Can be a group's short (5 or 6 character ID) or a group's UUID.

#### Request Body
- (object) - Optional - Partial group object.
```

--------------------------------

### Remove Member From Groups

Source: https://pluralkit.me/api/endpoints

Removes a member from one or more groups. Takes a list of group references as input. Returns 204 No Content on success.

```APIDOC
## Remove Member From Groups

### Description
Takes a list of group references as input. Returns 204 No Content on success.
TIP
If you want to remove _all_ groups from a member, consider using the Overwrite Member Groups endpoint instead.

### Method
POST

### Endpoint
`/members/{memberRef}/groups/remove`

### Parameters
#### Path Parameters
- **memberRef** (string) - Required - Can be a member's short (5 or 6 character ID) or a member's UUID.

#### Request Body
- (array) - Required - List of group references.
```

--------------------------------

### Remove Member From Group

Source: https://pluralkit.me/api/endpoints

Removes members from a specified group. For removing all members, use the Overwrite Group Members endpoint.

```APIDOC
## POST `/groups/{groupRef}/members/remove`

### Description
Removes members from a specified group. If you want to remove _all_ members from a group, consider using the Overwrite Group Members endpoint instead.

### Method
POST

### Endpoint
`/groups/{groupRef}/members/remove`

### Parameters
#### Path Parameters
- **groupRef** (string) - Required - The reference of the group to remove members from.

#### Request Body
- **members** (array of strings) - Required - An array of member references to remove from the group.

### Response
#### Success Response (204)
No Content on success.
```
Tokens:
Raw