Update a sandbox webhook
PATCH
/api/v1/sandbox/webhooks/{id}Change the URL, events, inbox or status (active / disabled). Owners and admins only.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | The id identifier. |
Request body
urlstringeventsarray<string>statusstringactive | disabledinbox_idstring
Request
PATCH
/api/v1/sandbox/webhooks/{id}curl -X PATCH 'https://app.mailyte.com/api/v1/sandbox/webhooks/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"url": "<string>",
"events": [],
"status": "<string>",
"inbox_id": "<string>"
}'const response = await fetch('https://app.mailyte.com/api/v1/sandbox/webhooks/01JBT8XQ2M9WYC3K4F6R7S8T9V', {
method: 'PATCH',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"url": "<string>",
"events": [],
"status": "<string>",
"inbox_id": "<string>"
}),
});
const { data } = await response.json();import requests
response = requests.patch(
"https://app.mailyte.com/api/v1/sandbox/webhooks/01JBT8XQ2M9WYC3K4F6R7S8T9V",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
json={
"url": "<string>",
"events": [],
"status": "<string>",
"inbox_id": "<string>"
},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->patch('https://app.mailyte.com/api/v1/sandbox/webhooks/01JBT8XQ2M9WYC3K4F6R7S8T9V', [
'url' => '<string>',
'events' => [],
'status' => '<string>',
'inbox_id' => '<string>',
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/sandbox/webhooks/01JBT8XQ2M9WYC3K4F6R7S8T9V")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
"url": "<string>",
"events": [],
"status": "<string>",
"inbox_id": "<string>"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectidstringorganization_idstringinbox_idstringThe inbox whose messages fire it. Null means every inbox in the organization.
urlstringeventsarray<string>statusstringactive | disabledcreated_atstringWhen it was created.
updated_atstringWhen it was last changed.
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.