Skip to main content
POST
Claim Custom Row

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Path Parameters

name
string
required

Body

application/json

Take one matching row and mark it.

Same filter and sort vocabulary as a query — the row you claim is the row that query would have returned first. patch is what changes about it, and it is deliberately not a filter: the caller says which row, the config says what happens to it.

patch
Patch · object
required

Declared properties to set on the claimed row, merged over what is already there. Cannot include the row key.

filters
QueryFilter · object[]
order
QuerySort · object[]

Response

Successful Response

found
boolean
required
record
Record · object | null