Edit
This route requires a valid Authorization
header.
PATCH/spheres/<identifier>
Path Params
Name | Type |
---|---|
identifier | SphereIdentifier |
Request Body
Field | Type | Description |
---|---|---|
name? | String? | The sphere’s display name. This field has to be between 1 and 32 characters. |
type | SphereType? | The sphere’s type. |
description? | String? | The sphere’s description, can be less than 4096 characters. |
icon? | Number? | The sphere’s icon. This field has to be a valid file ID in the “sphere-icons” bucket. |
banner? | Number? | The sphere’s banner. This field has to be a valid file ID in the “sphere-banners” bucket. |
Response
200Sphere
Field | Type | Description |
---|---|---|
id | Number | The spheres’s ID. |
owner_id | Number | The ID of the sphere’s owner. |
name? | String | The name of the sphere. |
slug | String | The slug of the sphere. |
type | SphereType | The sphere’s type. |
description? | String | The sphere’s description, can be between 1 and 4096 characters. |
icon? | Number | The sphere’s icon. This field has to be a valid file ID in the “sphere-icons” bucket. |
banner? | Number | The sphere’s banner. This field has to be a valid file ID in the “sphere-banners” bucket. |
badges | Number | The sphere’s badges as a bitfield. |
categories | Array of Categorys | The categories that this sphere contains. |
members | Array of Members | The members that are inside this sphere. |
emojis | Array of Emojis | The emojis that this sphere has. |