Dispatch

Update an endpoint

PATCH/v1/dispatch/endpoints/:id

Changes an endpoint's URL, event types, description or status.

Parameters

Path parameters1

idstringRequired

Destination ID (dst_…).

Body parameters4

url?string

New URL.

event_types?string[]

New event types.

description?string

New description.

status?string

active or paused.

Returns

200The sample response is on the right.Errors return error and message; see Errors and limits.

PATCHUpdate an endpoint

curl -X PATCH "https://api.getensue.com/v1/dispatch/endpoints/dst_…" \
  -H "authorization: Bearer $ENSUE_API_KEY"

const res = await fetch("https://api.getensue.com/v1/dispatch/endpoints/dst_…", {
  method: "PATCH",
  headers: {
    authorization: `Bearer ${process.env.ENSUE_API_KEY}`,
  },
});
console.log(await res.json());

import os, requests

res = requests.patch(
    "https://api.getensue.com/v1/dispatch/endpoints/dst_…",
    headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"},
)
print(res.json())

200Response

{
  "id": "dst_6r2n…",
  "customer_id": "cst_4h6w…",
  "customer": "acme",
  "url": "https://acme.example.com/hooks",
  "description": "",
  "status": "active",
  "event_types": [
    "order.shipped"
  ],
  "created": 1762761600000
}

{"id":"dst_6r2n…","customer_id":"cst_4h6w…","customer":"acme","url":"https://acme.example.com/hooks","description":"","status":"active","event_types":["order.shipped"],"created":1762761600000}