Objects and records
Upsert a record
Create or update a record using a stable UUID that your integration owns.
PUT
Create or update a record using a stable UUID that your integration owns.
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.
Existing values are merged, not fully replaced. An ID belonging to another workspace or object returns 409. Upsert does not restore archived records. Persist your source-to-UUID mapping before retries; do not generate a new UUID on every run.
Parameters
string
required
A valid UUID. Reuse the same UUID for the same external item.
string
required
Object ID or slug; required even when updating.
object
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. Defaults to an empty map.Response
201 —201 for creation or 200 for update, both with data containing the record.