registercheckby openlaw group
API referenceCollections

Update a collection item

PATCH
/collections/{collection_id}/items/{item_id}

Change an entry's note or its metadata. Metadata is merged: a key set to null is removed, a key not named is left alone.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

collection_id*string

The collection's id.

Formatuuid
item_id*string

The item's id.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

What can change about a collection entry. The entity cannot; remove the entry and add another.

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/collections/0395bbca-b4c7-4bfe-894b-e4e50256dc90/items/b10b7dd8-7ab3-40c1-8b5e-eb3932a08e20" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "collection_item",  "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",  "entity": {    "object": "company",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string"  },  "note": "string",  "created_at": "2019-08-24T14:15:22Z",  "metadata": {    "crm_id": "0015g00000XyZ",    "team": "kyc"  }}