registercheckby openlaw group
API referenceDestinations

Update a destination

PATCH
/destinations/{destination_id}

Turn a destination off, or back on, or change its metadata.

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

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

A destination that is a monitor's delivery route is told at the monitor's check and keeps the instant cadence: asking another answers 409 with code route_endpoint. Re-enabling a destination whose address another live destination holds answers 409 conflict.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

destination_id*string

The destination's id (dst_…). The id it is stored under -- a UUID, or the readable id of a destination created before this API existed -- is still accepted until 2026-12-31.

Match^dst_[0-7][0-9a-hjkmnp-tv-z]{25}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

What can change about a destination: whether it is live, its cadence, its metadata, and which events it is sent. An address cannot be edited — create a new destination 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

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://api.registercheck.de/v1/destinations/dst_6hq30w96je9rnrmw1tknzhwb2n" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "disabled": true  }'
{  "object": "destination",  "id": "dst_6hq30w96je9rnrmw1tknzhwb2n",  "channel": "webhook",  "address": "https://example.com/webhooks/registercheck",  "cadence": "instant",  "role": "own",  "disabled": true,  "disabled_at": "2024-07-01T09:00:00Z",  "disabled_reason": "disabled through the API by the customer",  "usable": true,  "unusable_reason": null,  "requires_plan": null,  "metadata": {    "crm_id": "0015g00000XyZ"  },  "created_at": "2024-05-20T08:15:00Z",  "updated_at": "2024-07-01T09:00:00Z",  "enabled_events": [    "delivery"  ]}