Skip to content
View as Markdown

PUT Update Webhook​

PUT
/webhooks/{id}

Update an existing webhook's configuration. SMS webhooks cannot be edited; they must be deleted and recreated instead. The webhook's id and url fields are immutable and cannot be changed through this endpoint.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The webhook ID to update.

Type
integer
Required

Request Body​

application/json
JSON
{
"name": "string",
"status": "string",
"lists": [
0
],
"tags": [
0
],
"companies": [
0
]
}

Responses​

Webhook updated successfully.

application/json
JSON
{
"webhooks": [
{
"id": 0,
"object_type": "string",
"key": "string",
"value": {
"name": "string",
"status": "string",
"lists": [
0
],
"tags": [
0
],
"companies": [
0
],
"url": "string"
},
"created_at": "string",
"updated_at": "string"
}
],
"message": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI