>>

Edit

This route requires a valid Authorization header.

PATCH/spheres/<identifier>

>>

Path Params

NameType
identifierSphereIdentifier
>>

Request Body

FieldTypeDescription
name?String?The sphere’s display name. This field has to be between 1 and 32 characters.
typeSphereType?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

FieldTypeDescription
idNumberThe spheres’s ID.
owner_idNumberThe ID of the sphere’s owner.
name?StringThe name of the sphere.
slugStringThe slug of the sphere.
typeSphereTypeThe sphere’s type.
description?StringThe sphere’s description, can be between 1 and 4096 characters.
icon?NumberThe sphere’s icon. This field has to be a valid file ID in the “sphere-icons” bucket.
banner?NumberThe sphere’s banner. This field has to be a valid file ID in the “sphere-banners” bucket.
badgesNumberThe sphere’s badges as a bitfield.
categoriesArray of CategorysThe categories that this sphere contains.
membersArray of MembersThe members that are inside this sphere.
emojisArray of EmojisThe emojis that this sphere has.