Update a sandbox webhook

PATCH/api/v1/sandbox/webhooks/{id}
Requires anorganization API keywith the scopesandbox:write

Change the URL, events, inbox or status (active / disabled). Owners and admins only.

Parameters

NameInTypeDescription
idrequiredpathstringThe id identifier.

Request body

  • urlstring
  • eventsarray<string>
  • statusstringactive | disabled
  • inbox_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>"
  }'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • idstring
    • organization_idstring
    • inbox_idstring

      The inbox whose messages fire it. Null means every inbox in the organization.

    • urlstring
    • eventsarray<string>
    • statusstringactive | disabled
    • created_atstring

      When it was created.

    • updated_atstring

      When it was last changed.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The 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.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too 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.