# Update a webhook endpoint (/api-reference/webhooks/updateWebhookEndpoint)

## PATCH /api/v1/webhook-endpoints/{endpoint_id}

Operation ID: `updateWebhookEndpoint`
Update a webhook endpoint
Changes only the fields you send. Re-enabling a disabled endpoint clears its failure count.

### Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `endpoint_id` | path | yes | Webhook endpoint id. |

### Request body

`application/json` (required)

```json
{
  "properties": {
    "description": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "New label.",
      "title": "Description"
    },
    "enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Enable or pause deliveries. Enabling clears the failure count and disabled reason.",
      "title": "Enabled"
    },
    "events": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "maxItems": 50,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "Replaces the event filter. Empty means every event type.",
      "title": "Events"
    },
    "url": {
      "anyOf": [
        {
          "maxLength": 2048,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "New endpoint URL.",
      "title": "Url"
    }
  },
  "title": "WebhookEndpointUpdate",
  "type": "object"
}
```

Example:

```json
{
  "enabled": true,
  "events": []
}
```

### Responses

#### 200 OK

Example (example):

```json
{
  "success": true,
  "webhookEndpoint": {
    "consecutiveFailures": 0,
    "createdAt": "2026-11-01T08:15:00+00:00",
    "description": "CRM sync",
    "enabled": true,
    "events": [],
    "id": "4f0c2a8e-7b1d-4c39-9a51-2d6e8f3b1c07",
    "lastStatus": "HTTP 200",
    "lastSuccessAt": "2026-11-15T10:42:07.512000+00:00",
    "updatedAt": "2026-11-15T10:42:07.512000+00:00",
    "url": "https://example.com/hooks/call-mitra"
  }
}
```

#### 400 Bad request: `webhook_event_type_unknown`, `webhook_https_required`, `webhook_url_invalid`.

Example (One or more event types are not recognised.):

```json
{
  "detail": "One or more event types are not recognised.",
  "error": {
    "code": "webhook_event_type_unknown",
    "docUrl": "https://docs.callmitra.ai/errors/webhook_event_type_unknown",
    "message": "One or more event types are not recognised.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "invalid_request_error"
  }
}
```

Example (The webhook URL must use https.):

```json
{
  "detail": "The webhook URL must use https.",
  "error": {
    "code": "webhook_https_required",
    "docUrl": "https://docs.callmitra.ai/errors/webhook_https_required",
    "message": "The webhook URL must use https.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "invalid_request_error"
  }
}
```

Example (The webhook URL is not a valid public URL.):

```json
{
  "detail": "The webhook URL is not a valid public URL.",
  "error": {
    "code": "webhook_url_invalid",
    "docUrl": "https://docs.callmitra.ai/errors/webhook_url_invalid",
    "message": "The webhook URL is not a valid public URL.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "invalid_request_error"
  }
}
```

#### 401 Unauthorized: `api_key_expired`, `invalid_api_key`, `unauthenticated`.

Example (The API key has expired.):

```json
{
  "detail": "The API key has expired.",
  "error": {
    "code": "api_key_expired",
    "docUrl": "https://docs.callmitra.ai/errors/api_key_expired",
    "message": "The API key has expired.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "authentication_error"
  }
}
```

Example (The API key is invalid or has been revoked.):

```json
{
  "detail": "The API key is invalid or has been revoked.",
  "error": {
    "code": "invalid_api_key",
    "docUrl": "https://docs.callmitra.ai/errors/invalid_api_key",
    "message": "The API key is invalid or has been revoked.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "authentication_error"
  }
}
```

Example (Authentication required.):

```json
{
  "detail": "Authentication required.",
  "error": {
    "code": "unauthenticated",
    "docUrl": "https://docs.callmitra.ai/errors/unauthenticated",
    "message": "Authentication required.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "authentication_error"
  }
}
```

#### 403 Forbidden: `api_key_scope_denied`, `permission_denied`.

Example (The API key does not have the scope required for this request.):

```json
{
  "detail": "The API key does not have the scope required for this request.",
  "error": {
    "code": "api_key_scope_denied",
    "docUrl": "https://docs.callmitra.ai/errors/api_key_scope_denied",
    "message": "The API key does not have the scope required for this request.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "permission_error"
  }
}
```

Example (You do not have permission to perform this action.):

```json
{
  "detail": "You do not have permission to perform this action.",
  "error": {
    "code": "permission_denied",
    "docUrl": "https://docs.callmitra.ai/errors/permission_denied",
    "message": "You do not have permission to perform this action.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "permission_error"
  }
}
```

#### 404 Not found: `webhook_endpoint_not_found`.

Example (Webhook endpoint not found.):

```json
{
  "detail": "Webhook endpoint not found.",
  "error": {
    "code": "webhook_endpoint_not_found",
    "docUrl": "https://docs.callmitra.ai/errors/webhook_endpoint_not_found",
    "message": "Webhook endpoint not found.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "not_found_error"
  }
}
```

#### 422 Invalid parameters: `parameter_invalid`.

Example (One or more parameters are invalid.):

```json
{
  "detail": [
    {
      "loc": [
        "body",
        "phone"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "error": {
    "code": "parameter_invalid",
    "docUrl": "https://docs.callmitra.ai/errors/parameter_invalid",
    "message": "One or more parameters are invalid.",
    "param": "phone",
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "invalid_request_error"
  }
}
```

#### 429 Too many requests: `rate_limit_exceeded`.

Example (Too many requests. Slow down and retry later.):

```json
{
  "detail": "Too many requests. Slow down and retry later.",
  "error": {
    "code": "rate_limit_exceeded",
    "docUrl": "https://docs.callmitra.ai/errors/rate_limit_exceeded",
    "message": "Too many requests. Slow down and retry later.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "rate_limit_error"
  }
}
```

#### 500 Server error: `internal_error`.

Example (Something went wrong on our side.):

```json
{
  "detail": "Something went wrong on our side.",
  "error": {
    "code": "internal_error",
    "docUrl": "https://docs.callmitra.ai/errors/internal_error",
    "message": "Something went wrong on our side.",
    "param": null,
    "requestId": "req_5f1c2e9b7a3d4c0e8b6a1f2d3c4b5a69",
    "type": "api_error"
  }
}
```

### Error codes

- [`webhook_event_type_unknown`](/errors/webhook_event_type_unknown)
- [`webhook_https_required`](/errors/webhook_https_required)
- [`webhook_url_invalid`](/errors/webhook_url_invalid)
- [`api_key_expired`](/errors/api_key_expired)
- [`invalid_api_key`](/errors/invalid_api_key)
- [`unauthenticated`](/errors/unauthenticated)
- [`api_key_scope_denied`](/errors/api_key_scope_denied)
- [`permission_denied`](/errors/permission_denied)
- [`webhook_endpoint_not_found`](/errors/webhook_endpoint_not_found)
- [`parameter_invalid`](/errors/parameter_invalid)
- [`rate_limit_exceeded`](/errors/rate_limit_exceeded)
- [`internal_error`](/errors/internal_error)
