Webhooks
Update a webhook subscription
Partially update a webhook subscription. Only provided fields are modified; omitted fields remain unchanged.
Authorization
ApiKeyAuth x-api-key<token>
API key for authentication. Get your key from the Whitepages developer portal.
In: header
Path Parameters
webhook_id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for partially updating a webhook.
Only provided fields are updated; omitted fields remain unchanged.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/webhooks/string" \ -H "Content-Type: application/json" \ -d '{}'{
"result": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"url": "https://api.example.com/webhooks/wp-events",
"name": "Austin metro deed alerts",
"event_type": "deed.*",
"region": "county:tx.travis",
"status": "active",
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-02-20T14:45:00Z"
}
}{
"error": {
"code": 400,
"message": "Bad Request",
"long_message": "Invalid person ID format: 'sdf'. Person ID must start with 'P' followed by exactly 10 alphanumeric characters. Example: 'PABcd12345e' or 'P1234567890'.",
"meta": null
},
"wp_trace_id": "3b0b537a60d84057817bb40563ca5c99"
}{
"message": "Forbidden"
}{
"error": {
"code": 404,
"message": "Not Found",
"long_message": "Person id not found: PABcd12345e",
"meta": null
},
"wp_trace_id": "0c57473114bd49b3b3c4b585df624f2f"
}{
"error": {
"code": 400,
"message": "Short error message",
"long_message": "The request was malformed",
"meta": {
"field": "email",
"validation_error": "Invalid email format"
}
},
"wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}{
"error": {
"code": 422,
"message": "Unprocessable Entity",
"long_message": "The request contains semantic errors and cannot be processed",
"meta": null
},
"wp_trace_id": "7e5f2c9a1d8b4e6f9c0a3b5d7e1f2a4c"
}{
"error": {
"code": 500,
"message": "Internal Server Error",
"long_message": "An internal server error occurred",
"meta": null
},
"wp_trace_id": "9c1a4e7f2b8d4c6a9e0f3b5d7c1a2e4f"
}