Objects and records
Update a record
Merge supplied values into an active record.
PATCH
Merge supplied values into an active record.
Use a developer access key. See authentication, errors, and rate limits.
Required scopes:
Set path-ID environment variables to values returned by your workspace before running the request.
This request changes workspace data. A timeout does not prove that the write failed; inspect the result before retrying.
records:write.
An archived record returns 404; restore it before patching. A field’s accepted empty value depends on its type—do not assume null clears every field.
Parameters
string
required
Record ID in the key’s workspace.
object
required
Map writable field IDs or unambiguous slugs to values matching their field definitions. Unknown fields are rejected. Read-only fields are ignored. Discover the schema first; the example assumes a text field named
name on clients. Omitted fields retain their current values.Response
200 — Returns the record model underdata. Example IDs and values are illustrative.