patch/webhooks/{webhook_id}/{token}

Update webhook with token

Updates the specified webhook using its ID and token for authentication. Allows modification of name or avatar. Returns the updated webhook object without creator user data.

update_webhook_with_token

Parameters

Name	In	Type	Description
webhook_id*	path	SnowflakeType	The ID of the webhook
token*	path	string	The token

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The new name of the webhook"
    },
    "avatar": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Base64ImageType"
        },
        {
          "type": "null"
        }
      ],
      "description": "The new avatar image as a base64-encoded data URI"
    }
  }
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "description": "The unique identifier (snowflake) for the webhook"
    },
    "guild_id": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "description": "The ID of the guild this webhook belongs to"
    },
    "channel_id": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "description": "The ID of the channel this webhook posts to"
    },
    "name": {
      "type": "string",
      "description": "The display name of the webhook"
    },
    "avatar": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The hash of the webhook avatar image"
    },
    "token": {
      "type": "string",
      "description": "The secure token used to execute the webhook"
    }
  },
  "required": [
    "id",
    "guild_id",
    "channel_id",
    "name",
    "token"
  ]
}

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"
  ]
}

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"
  ]
}