registercheckby openlaw group
API referenceMonitoring

Update a notification endpoint

PATCH
/notification-endpoints/{endpoint_id}

Turn an endpoint off, or back on.

A destination cannot be edited. Past deliveries reference the endpoint by id, so re-pointing one would attribute them to an address that never received them — create a new endpoint and disable the old one instead.

Re-enabling clears disabled_reason, including one we set ourselves after repeated failures.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer rc_live_….

In: header

Path Parameters

endpoint_id*string

The endpoint's id, as returned when it was created. An opaque string, not necessarily a UUID — endpoints created before this API existed carry readable ids.

Lengthlength <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

What can change about an endpoint: whether it is live, and its metadata. A destination cannot be edited — create a new endpoint and disable the old one.

Properties1 <= properties

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://api.registercheck.de/v1/notification-endpoints/7d8f0bf7-6b30-4d21-8dc7-4df98554c804" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "object": "notification_endpoint",  "channel": "email",  "destination": "string",  "disabled": true,  "disabled_at": "2019-08-24T14:15:22Z",  "disabled_reason": "string",  "usable": true,  "unusable_reason": "string",  "metadata": {    "crm_id": "0015g00000XyZ",    "team": "kyc"  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}