registercheckby openlaw group
Get started

Metadata

Your own key-value pairs on monitors, destinations, lists, list items, jobs and formations.

Every object you create carries metadata: a map of your own string keys to string values (a search monitor's is always empty). Put your CRM id on a monitor, your team's name on a destination, a deal stage on a list item — and read it back on every response for that object. Registercheck stores it and returns it; it never reads it or acts on it.

A webhook delivery carries events, not your monitors' metadata: keep your own map from monitor id to record (you get the id back when you create the monitor), or read the monitor.

It works exactly like Stripe's metadata, with the same limits:

LimitValue
Keys per object50
Key length40 characters, no square brackets
Valuea string of at most 500 characters

Available on monitors, destinations, lists, list items, jobs and formations (set with PATCH; changing a formation's metadata costs 1 credit).

Set it when you create

curl -X POST https://api.registercheck.de/v1/monitors \
  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject_id": "cmp_63b6n0c6p09pnsrr6nrtd0dzsc",
       "metadata": {"crm_id": "0015g00000XyZ", "team": "kyc"}}'

Change it with PATCH

An update is merged into what is stored: a key with a string value is added or replaced, a key set to null is removed, and keys you do not name are left alone. $MONITOR_ID is the id the create answered.

curl -X PATCH https://api.registercheck.de/v1/monitors/$MONITOR_ID \
  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"team": null, "region": "sued"}}'
# -> "metadata": {"crm_id": "0015g00000XyZ", "region": "sued"}

A request that would leave more than 50 keys, or break another limit, answers 400 and changes nothing.

Not for secrets or personal data

Metadata is returned on every read of the object, to everyone who can read it. Store references to your own records, not passwords, tokens or personal data.

On this page