Objects

Upsert Object Record

Create (201) or update (200) by a unique key, preserving omitted fields.

A revision requires an existing matching record; a stale or absent match returns 409. Validation, matching, and mutation share one transaction.

post/objects/{object_slug}/records/upsert

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/objects/{object_slug}/records/upsert
  • Auth: HTTP bearer

Path parameters

object_slugstring required

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

valuesobject

Attribute values keyed by slug. Call GET /objects/{object_slug}/attributes for active fields. Canonical contacts and companies retain CONTACT_, COMPANY_ and udo_* field names. Unknown keys are rejected with 422. PATCH preserves omitted fields; required fields cannot be cleared with null or an empty multivalue list. Record references must resolve to active records of their configured target object in the same organization and app.

matching_attributestring required

Active single-value unique attribute. Its nonempty value must be supplied in values.

expected_revisioninteger nullable

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.