Update a webhook subscription

curl --request PATCH \
  --url https://app.sendmux.ai/api/v1/webhooks/{public_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://app.sendmux.ai/api/v1/webhooks/{public_id}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://app.sendmux.ai/api/v1/webhooks/{public_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sendmux.ai/api/v1/webhooks/{public_id}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": true,
  "data": {
    "created_at": "2026-04-23T09:12:00Z",
    "enabled": true,
    "event_types": [
      "message.bounced",
      "message.received"
    ],
    "failing": false,
    "filters": {
      "mailbox_ids": [
        "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
      ]
    },
    "id": "whk_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Acme inbound forwarder",
    "updated_at": "2026-04-23T09:12:00Z",
    "url": "https://hooks.acme.com/sendmux"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

Webhooks

Update a webhook subscription

Updates the URL, event types, or enabled flag. Any field omitted from the request body is left unchanged. The signing secret is unaffected — use POST /webhooks/{id}/rotate-secret to rotate it.

For optimistic concurrency, send If-Match: <etag> using the ETag from a prior GET. A mismatched If-Match returns 409 conflict (the server’s ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.

PATCH

webhooks

{public_id}

Update a webhook subscription

curl --request PATCH \
  --url https://app.sendmux.ai/api/v1/webhooks/{public_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://app.sendmux.ai/api/v1/webhooks/{public_id}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://app.sendmux.ai/api/v1/webhooks/{public_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sendmux.ai/api/v1/webhooks/{public_id}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": true,
  "data": {
    "created_at": "2026-04-23T09:12:00Z",
    "enabled": true,
    "event_types": [
      "message.bounced",
      "message.received"
    ],
    "failing": false,
    "filters": {
      "mailbox_ids": [
        "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
      ]
    },
    "id": "whk_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Acme inbound forwarder",
    "updated_at": "2026-04-23T09:12:00Z",
    "url": "https://hooks.acme.com/sendmux"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

Authorizations

Authorization

string

header

required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-Match

string

Weak ETag from a prior GET. Reject with 409 conflict when the server's current ETag differs.

Path Parameters

public_id

string

required

Webhook public ID

Body

application/json

enabled

boolean

When toggled from false to true, also clears the failing flag — retry deliveries resume on the next matching event.

event_types

enum<string>[]

Replaces the full event-type list. At least one must be provided.

Minimum array length: 1

Event types a webhook may subscribe to. sendmux.test is accepted so you can verify end-to-end delivery via POST /webhooks/{id}/test.

Available options:

message.delivered,

message.bounced,

message.complained,

message.rejected,

message.delivery_delayed,

message.received,

message.received.spam,

sendmux.test

filters

object

Replaces the full delivery scope. Omit to leave unchanged; pass an empty mailbox_ids array for all team mailboxes.

Hide child attributes

filters.mailbox_ids

string[]

required

Mailbox public IDs to receive events for. Empty means all mailboxes in the team.

Example:

["mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"]

name

string | null

Replace the human-friendly label. Send null to clear it; omit to leave unchanged.

Maximum string length: 255

url

string<uri>

New HTTPS endpoint. Must be https://.

Response

Updated subscription

Overview

Domains

Mailboxes

Inbox logs

Sending accounts

Emails

Billing

Webhooks

Update a webhook subscription

Authorizations

Headers

Path Parameters

Body

Response