v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Update a custom object record

Updates an existing record by ID for the specified custom object type. Only included fields and relationships are modified.

post/v1/objects/{entitySlug}/values/{id}

Path parameters

entitySlugstring required

The slug of the custom object type.

idstring required

The ID of the record to update.

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Request body

fieldsobject

Field names to values. Only provided fields are modified.

relationshipsobject

Relationship names to operations (add, remove, or replace).

Response

OK

idstring required

Unique identifier for the entity.

createdAtstring required

ISO 8601 timestamp of when the entity was created.

updatedAtstring nullable required

ISO 8601 timestamp of when the entity was last updated, or null.

httpLinkstring nullable required

URL to view the entity in the Lightfield web app, or null.

externalIdstring nullable

External identifier for the entity, or null if unset.

fieldsobject required

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

relationshipsobject required

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).