Content Management

Rocket.Chat provides various options to personalize your workspace according to your needs. The following endpoints are used to manage workspace resources:

The custom emoji object

Custom emoji endpoints return emoji objects. A trimmed example from List All Custom Emojis:

{
  "emojis": [
    {
      "_id": "6542e83aa2f73c7460e18efb",
      "name": "happy",
      "aliases": ["happy-gang"],
      "extension": "png",
      "_updatedAt": "2023-11-01T19:33:46.674Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "total": 1,
  "success": true
}

Fields you use most often:

• _id: The unique emoji ID. Pass it as emojiId when updating or deleting an emoji.

• name: The emoji name used in messages, as :name:.

• aliases: Alternative names that also render the emoji.

• extension: The image file type of the uploaded emoji.

Assets API

• Upload and remove workspace assets to customize your workspace.

• For details on the assets you can use, see the Assets user guide.

Brand your workspace with assets

1. Set an asset, such as a logo or favicon, by uploading the image with the asset name.

2. Unset the asset to revert to the default.

Custom emoji API

• Create, update, and delete custom emojis for your workspace.

• View the list of available custom emojis on your workspace.

• For details, refer to the Manage custom emojis user guide.

Manage custom emojis

1. Create an emoji by uploading an image file with a name and optional aliases.

2. List all custom emojis to find an emoji's _id.

3. Update the emoji to change its name, aliases, or image, or delete it.

Custom sounds API

• View the list of available custom sounds on your workspace.

• For details, refer to the Manage custom sounds user guide.

Manage custom sounds

1. Create a custom sound by uploading an audio file.

2. List custom sounds to find a sound's ID.

3. Update or delete the sound.

Custom status API

• Create, update, and delete the custom user statuses in your workspace using the available endpoints.

• View the list of available custom statuses in your workspace.

• For details, refer to the Custom User Status user guide.

Manage custom user statuses

1. Create a custom status with a name and presence status.

2. List custom user statuses to find a status ID.

3. Update or delete the status.

Conventions

• Endpoints that upload files, such as creating emojis, sounds, or assets, expect multipart/form-data request bodies instead of JSON.

• These are administrative endpoints. They require permissions such as manage-emoji, manage-sounds, manage-user-status, or manage-assets. Each endpoint page lists its required permissions.

• List endpoints support count, offset, sort, and query query parameters.