Skip to content
Teamander Mail

Update a webhook endpoint

PATCH
/webhook-endpoints/{id}
curl --request PATCH \
  --url https://mail.teamander.com/v1/webhook-endpoints/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "active": false }'

Change the URL, subscribed events, or toggle active.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

Resource identifier

string
Example
a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request Body

Section titled “Request Body”
Media typeapplication/json
object
url
string format: uri
<= 2048 characters
events
Array<string>
>= 1 items <= 9 items
Allowed values: email.sent email.delivered email.deferred email.bounced email.complained email.failed email.opened email.clicked email.unsubscribed
active
boolean
Example
{
  "active": false
}

Responses

Section titled “Responses”

200

Section titled “200”

Updated endpoint

Media typeapplication/json
object
id
required
integer
url
required
string
events
required
Array<string>
active
required
boolean
created_at
required
string
Examplegenerated
{
  "id": 1,
  "url": "example",
  "events": [
    "example"
  ],
  "active": true,
  "created_at": "example"
}

400

Section titled “400”

Validation failed

Media typeapplication/json
object
error
required
string
details
object
key
additional properties
nullable
Example
{
  "error": "Validation failed",
  "details": {}
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
error
required
string
message
string
Example
{
  "error": "Invalid API key"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
string
Example
{
  "error": "not_found"
}