patch/webhooks/{webhook_id}

Update webhook

Updates the specified webhook with new settings such as name, avatar, or target channel. All fields are optional. Returns the updated webhook object.

update_webhook

Parameters

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

Request body

application/json

json

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

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier (snowflake) for the webhook",
      "$ref": "#/components/schemas/SnowflakeStringType"
    },
    "guild_id": {
      "description": "The ID of the guild this webhook belongs to",
      "$ref": "#/components/schemas/SnowflakeStringType"
    },
    "channel_id": {
      "description": "The ID of the channel this webhook posts to",
      "$ref": "#/components/schemas/SnowflakeStringType"
    },
    "name": {
      "type": "string",
      "description": "The display name of the webhook"
    },
    "avatar": {
      "description": "The hash of the webhook avatar image",
      "type": [
        "string",
        "null"
      ]
    },
    "type": {
      "$ref": "#/components/schemas/WebhookType"
    },
    "token": {
      "description": "The secure token used to execute the webhook, omitted for channel follower webhooks",
      "type": "string"
    },
    "user": {
      "description": "The user who created the webhook",
      "$ref": "#/components/schemas/UserPartialResponse"
    },
    "source_guild": {
      "description": "The guild of the followed announcement channel, present on channel follower webhooks while the creator can view it",
      "type": "object",
      "properties": {
        "id": {
          "description": "The ID of the guild that owns the followed announcement channel",
          "$ref": "#/components/schemas/SnowflakeStringType"
        },
        "name": {
          "type": "string",
          "description": "The name of the guild that owns the followed announcement channel"
        },
        "icon": {
          "description": "The icon hash of the guild that owns the followed announcement channel",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "name"
      ],
      "additionalProperties": false
    },
    "source_channel": {
      "description": "The followed announcement channel, present on channel follower webhooks while the creator can view it",
      "type": "object",
      "properties": {
        "id": {
          "description": "The ID of the followed announcement channel",
          "$ref": "#/components/schemas/SnowflakeStringType"
        },
        "name": {
          "type": "string",
          "description": "The name of the followed announcement channel"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "guild_id",
    "channel_id",
    "name",
    "type",
    "user"
  ],
  "additionalProperties": false
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}