patch/guilds/{guild_id}/channels

Update channel positions

Update channel positions. Requires manage_channels permission. Reorders channels and optionally changes parent categories and permission locks.

update_guild_channel_positions

Parameters

Name	In	Type	Description
guild_id*	path	SnowflakeType	The ID of the guild

Request body

application/json

json

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "$ref": "#/components/schemas/SnowflakeType"
      },
      "position": {
        "type": "integer",
        "minimum": 0,
        "maximum": 9007199254740991,
        "format": "int53",
        "description": "New position for the channel"
      },
      "parent_id": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/SnowflakeType"
          },
          {
            "type": "null"
          }
        ],
        "description": "New parent category ID"
      },
      "preceding_sibling_id": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/SnowflakeType"
          },
          {
            "type": "null"
          }
        ],
        "description": "ID of the sibling channel that should directly precede this channel after reordering"
      },
      "lock_permissions": {
        "type": "boolean",
        "description": "Whether to sync permissions with the new parent"
      }
    },
    "required": [
      "id"
    ]
  }
}

Responses

204

No Content

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}