DemandFlow Support Centre

API: PATCH /v1/objects/{id}. Update an object

ReferenceAPI Reference16/04/2026Updated 16/04/2026
Update one or more fields on an existing object. Returns the updated record with a bumped _df_version. Bypasses any fields you do not send.

PATCH /v1/objects/{id}

Updates selected fields on an existing object and returns the full updated record.

Path parameters

  • id, the object's UUID.

Query parameters

  • entity (optional), uppercase entity code, for routing to the correct backing store.

Request body

A raw JSON object containing only the fields you want to change. Fields you do not include are left untouched.

System fields id, ownerId, and created are ignored if present.

What happens on the server

  • The server sets updated (timestamp) and updatedId (your user).
  • _df_version is incremented by 1.
  • Real-time push notifications are sent to any subscribers of the record.
  • Automation workflows fire for entities that have automations configured.
  • The change is written to the audit log.

Responses

  • 200. JSON object representing the updated record (with bumped _df_version and new updated timestamp).
  • 400, missing id, malformed body.
  • 403, the object belongs to another tenant.
  • 404, object not found.

Example

curl -X PATCH "https://rest.demandflow.com/v1/objects/a1b2c3d4-e5f6-4890-abcd-ef1234567890" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Ada Lovelace (Countess)", "title": "Countess"}'

See also

apipatchupdateeditmodifyobjectversion

Was this article helpful?

← Back to Knowledge Base