PATCHAPI key

Update an endpoint

PATCHapi.schedulesmcp.com/v1/webhooks/{id}

Change the URL, the subscription, the label or the enabled state. Send only the fields you want to change. Setting active to true also resets failure_count to zero, which is how you bring back an endpoint we auto-disabled. A url that is not https is ignored rather than rejected, so read the returned url back. Management, so a valid key is enough. Answers 404 NOT_FOUND for an unknown id.

Path parameters

idstringrequired

Endpoint id.

Request body

urlstring

New URL. Ignored unless it starts with https://.

event_typesstring[]

Replaces the subscription outright. Unrecognised names are dropped.

descriptionstring

New label.

activeboolean

Enable or disable. True also clears failure_count.

Response fields

Derived from the example response.

okboolean

Whether the request succeeded.

dataobject

The payload. Everything an endpoint returns sits under this key.

data.idstring

Stable identifier for the record. On the tracking endpoints this is the container UUID, except on a portfolio summary row, where it is the container number.

data.urlstring

data.event_typesstring[]

data.descriptionstring

The carrier own phrasing for the event, falling back to our word for the code.

data.activeboolean

curl -X PATCH 'https://api.schedulesmcp.com/v1/webhooks/3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10' \
  -H "Authorization: Bearer smcp_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":true}'

const res = await fetch("https://api.schedulesmcp.com/v1/webhooks/3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer smcp_YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "active": true
  })
});
const data = await res.json();

import requests

res = requests.patch(
    "https://api.schedulesmcp.com/v1/webhooks/3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10",
    headers={"Authorization": "Bearer smcp_YOUR_API_KEY"},
    json={
      "active": True
    },
)
data = res.json()

Response

{
  "ok": true,
  "data": {
    "id": "3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10",
    "url": "https://hooks.example.com/schedulesmcp",
    "event_types": ["blank_sailing", "cutoff_approaching"],
    "description": "Sailing alerts, booking desk",
    "active": true
  }
}