Skip to main content
PATCH
Update entity records by filter

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app that owns the entity.

entity_name
string
required

Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.

Body

application/json
query
object
required

Filter selecting the records to change, in the same form as q. Send {} to match every record.

Example:
data
object
required

The change, as one or more update operators, each mapping field names to values.

Example:

Response

How many records changed.

How many records a filtered update changed.

success
boolean
required

Always true. An update that doesn't happen returns an error instead.

Example:

true

updated
integer
required

Number of matching records the call changed. A record that already held the new values still counts, because its updated_date changes, and 0 means no record matched.

Example:

42

has_more
boolean
required

Whether more than 500 records matched, so only 500 of them were changed and more may be left.

Example:

false