---
title: "Edit Bot"
method: PATCH
path: "/bots/{bot_id}"
tags: ["Bots"]
---

# Edit Bot

`PATCH /bots/{bot_id}`

Edit bot details by its id.

## Path parameters

- `bot_id` string, required

## Request body

- DataEditBot — New Bot Details
  - `name` string, nullable — Bot username
  - `public` boolean, nullable — Whether the bot can be added by anyone
  - `analytics` boolean, nullable — Whether analytics should be gathered for this bot Must be enabled in order to show up on [Revolt Discover](https://rvlt.gg).
  - `interactions_url` string, nullable — Interactions URL
  - `remove` FieldsBot[] — Fields to remove from bot object

## Response `200`

- BotWithUserResponse — Bot with user response
  - `user` User, required — User
    - `_id` string, required — Unique Id
    - `username` string, required — Username
    - `discriminator` string, required — Discriminator
    - `display_name` string, nullable — Display name
    - `pronouns` string, nullable — User's pronouns
    - `avatar` File — File
      - `_id` string, required — Unique Id
      - `tag` string, required — Tag / bucket this file was uploaded to
      - `filename` string, required — Original filename
      - `metadata` union, required — Metadata associated with a file
        - object — File is just a generic uncategorised file
          - `type` 'File', required
        - object — File contains textual data and should be displayed as such
          - `type` 'Text', required
        - object — File is an image with specific dimensions, and may be animated
          - `type` 'Image', required
          - `width` integer, required
          - `height` integer, required
          - `thumbhash` integer[], nullable
          - `animated` boolean, nullable
        - object — File is a video with specific dimensions
          - `type` 'Video', required
          - `width` integer, required
          - `height` integer, required
        - object — File is audio
          - `type` 'Audio', required
      - `content_type` string, required — Raw content type of this file
      - `size` integer, required — Size of this file (in bytes)
      - `deleted` boolean, nullable — Whether this file was deleted
      - `reported` boolean, nullable — Whether this file was reported
      - `message_id` string, nullable
      - `user_id` string, nullable
      - `server_id` string, nullable
      - `object_id` string, nullable — Id of the object this file is associated with
    - `relations` Relationship[] — Relationships with other users
      - `_id` string, required — Other user's Id
      - `status` union, required — User's relationship with another user (or themselves)
        - 'None' — No relationship with other user
        - 'User' — Other user is us
        - 'Friend' — Friends with the other user
        - 'Outgoing' — Pending friend request to user
        - 'Incoming' — Incoming friend request from user
        - 'Blocked' — Blocked this user
        - 'BlockedOther' — Blocked by this user
    - `badges` integer — Bitfield of user badges https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserBadges.html
    - `status` UserStatus — User's active status
      - `text` string, nullable — Custom status text
      - `presence` union — Presence status
        - 'Online' — User is online
        - 'Idle' — User is not currently available
        - 'Focus' — User is focusing / will only receive mentions
        - 'Busy' — User is busy / will not receive any notifications
        - 'Invisible' — User appears to be offline
    - `flags` integer — Enum of user flags https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserFlags.html
    - `privileged` boolean — Whether this user is privileged
    - `bot` BotInformation — Bot information for if the user is a bot
      - `owner` string, required — Id of the owner of this bot
    - `relationship` union, required — User's relationship with another user (or themselves)
      - 'None' — No relationship with other user
      - 'User' — Other user is us
      - 'Friend' — Friends with the other user
      - 'Outgoing' — Pending friend request to user
      - 'Incoming' — Incoming friend request from user
      - 'Blocked' — Blocked this user
      - 'BlockedOther' — Blocked by this user
    - `online` boolean, required — Whether this user is currently online
  - `_id` string, required — Bot Id
  - `owner` string, required — User Id of the bot owner
  - `token` string, required — Token used to authenticate requests for this bot
  - `public` boolean, required — Whether the bot is public (may be invited by anyone)
  - `analytics` boolean — Whether to enable analytics
  - `discoverable` boolean — Whether this bot should be publicly discoverable
  - `interactions_url` string — Reserved; URL for handling interactions
  - `terms_of_service_url` string — URL for terms of service
  - `privacy_policy_url` string — URL for privacy policy
  - `flags` integer — Enum of bot flags

## Other responses

- `default` — An error occurred.

---

[API](https://skmtc.net/revolt/apis/revolt-api.md) · [All operations](https://skmtc.net/revolt/apis/revolt-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/revolt/revolt-api/versions/a235e4654b18/schema)