# Update Webhook

`PATCH https://api.getprospect.com/v2/webhooks/{id}`

Changes the URL, events, description or status (`active` / `paused`). Re-activating a disabled webhook resets its failure counters; one whose creator or API key is gone answers 409 `creator_removed`. The URL and events can be changed only by the member or API key that created the webhook (403 `creator_mismatch` otherwise). Free: no credits.

## Authentication

Pass your API key in the `x-api-key` header.

## Body parameters

- `url` (string, optional, max length: 2048): A new https URL on a public host. Only the creating member or API key may change it.
- `events` (enum[], optional): Replaces the event types (1-10, no repeats). Only the creating member or API key may change them. Allowed values: `person.saved`, `person.email_found`, `company.saved`.
- `description` (string, optional, max length: 200): A note for people reading the webhook list; null clears it.
- `status` (enum, optional): Pause or resume deliveries. Re-activating a disabled webhook resets its failure counters. Allowed values: `active`, `paused`.
- `api_version` (enum, optional): The payload version of the events (`2026-10`); defaults to the current one. Allowed values: `2026-10`.

## Path parameters

- `id` (string, required): The webhook id (24 hex characters).

## Example request

```bash
curl --request PATCH \
  --url https://api.getprospect.com/v2/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '
{
  "status": "paused"
}
'
```

## Response 200

The webhook after the change.

```json
{
  "success": true,
  "data": {
    "id": "6702a1b2c3d4e5f607182930",
    "url": "https://hooks.zapier.com/hooks/standard/1/abc/",
    "events": [
      "person.saved"
    ],
    "status": "active",
    "disabled_reason": null,
    "api_version": "2026-10",
    "description": "New saved people to Zapier",
    "created_by_user_id": "64a1b2c3d4e5f60718293a4b",
    "api_key_id": null,
    "last_delivery": {
      "at": "2026-10-08T11:58:02.000Z",
      "delivered": true,
      "status_class": "2xx"
    },
    "created_at": "2026-10-06T09:00:00.000Z",
    "updated_at": "2026-10-08T11:58:02.000Z"
  },
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  }
}
```

## Response 400

Malformed id or invalid body (`VALIDATION_ERROR`): `invalid_format` (the URL), `value_not_allowed`, `out_of_range` (1-10 events, or re-activating past 25 active webhooks), `wrong_type`, `unknown_field`.

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "VALIDATION_ERROR",
      "message": "status: \"disabled\" is not an accepted value. Accepted: active, paused",
      "payload": {
        "field": "status",
        "code": "value_not_allowed",
        "received_value": "disabled",
        "received_type": "string",
        "invalid_values": [
          "disabled"
        ],
        "allowed_values": [
          "active",
          "paused"
        ]
      }
    }
  ]
}
```

## Response 401

Missing, unknown or inactive credentials (`UNAUTHORIZED`).

## Response 403

Only the member or API key that created the webhook may change its URL or events (`FORBIDDEN`, `payload.code: creator_mismatch`).

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "FORBIDDEN",
      "message": "Only the member or API key that created this webhook can change its URL or events. Create your own webhook instead.",
      "payload": {
        "code": "creator_mismatch"
      }
    }
  ]
}
```

## Response 404

No such webhook in this workspace (`NOT_FOUND`).

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "NOT_FOUND",
      "message": "Webhook not found."
    }
  ]
}
```

## Response 409

The member or API key that created this webhook is gone, so it cannot be re-activated; create a new one (`CONFLICT`, `payload.code: creator_removed`).

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "CONFLICT",
      "message": "The member or API key that created this webhook is gone, so it cannot be re-activated. Create a new webhook.",
      "payload": {
        "code": "creator_removed"
      }
    }
  ]
}
```

## Response 500

Unexpected server error.