POST /v1/objects
Creates a new object in your subscription and returns the created record (with its new id and version).
Request body
A raw JSON object containing the fields of the new record. Three system fields are required on every create:
entity, uppercase entity code (e.g.PPL,PATENT).level, the numeric level from that entity's definition.comboKey, the hierarchical combo key for the new record. Must always end with|ENT:, the backend appends the new id directly onto that suffix. Omitting the trailing|ENT:produces a malformed combo key.
All other fields are entity-specific. See the relevant entity's documentation for which fields are required or defaulted.
Responses
- 201. JSON object representing the created record, including the server-assigned
idand_df_version: 0. - 400, missing body, not a JSON object, or invalid JSON.
Example, create a person
curl -X POST "https://rest.demandflow.com/v1/objects" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"entity": "PPL",
"level": 220,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Ada Lovelace",
"firstName": "Ada",
"lastName": "Lovelace"
}'
Example, create a child record
When the new record is a child of another (e.g. a patent application under a patent), include the parent in the combo key before the trailing |ENT::
{
"entity": "PATENTA",
"level": 430,
"comboKey": "SUB:<your-sub-id>|PAT:<parent-patent-id>|ENT:",
"name": "Application Title"
}