Skip to main content
POST
Bulk upsert entities by ID

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Query Parameters

auto_assign_owner
boolean

Whether newly inserted entities in the upsert batch are assigned to the authenticated user. Defaults to true; existing entities are unaffected.

branch_id
string

Branch to write all entities to. Omit or pass "master" for the base branch.

Body

application/json
entityType
string
required

Entity type (e.g. "task", "bug"). Must match an existing type in the schema.

id
string
required

Entity ID (UUID). Must be unique within the project.

values
object
required

Key-value pairs to compare and write. Only keys whose values differ from the stored state will produce diffs.

idField
string

Optional field key to match id against instead of treating id as the Flow entity id. When set, id is interpreted as an external identifier and matched against the current value of this field across existing entities on the branch: a match reuses that entity, a miss creates a new one with a freshly generated Flow id. This decouples the Flow entity id from any one external field (e.g. match on a custom "ReqIF ID" field). Omit (or leave the field empty) to keep the default behaviour where id is the Flow entity id verbatim.

parentIds
string[]

Optional list of parent entity IDs. For each parent, a downstream link is created from that parent to this entity if one does not already exist. Existing upstream links that are not listed here are left untouched.

Response

200 - application/json
formulaTemplates
object
required
formulas
object
required
id
string
required
values
object
required
branchesChangedIn
string[]
branchesCreatedIn
string[]
createdAt
string<date-time>
defaultSortKey
string
deleted
boolean
type
string
uniqueEntityNumber
number
updatedAt
string<date-time>