Skip to navigation

Link multiple entities at once

View as Markdown
Creates multiple relationships between the source entity and target entities. Each link can be a different relationship type and direction.

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

entity_typeenumRequired

The entity type (e.g. REQUEST, CHANGE)

display_idstringRequired

The display ID of the source entity (e.g. REQ-123, CHG-456)

Headers

X-Workspace-IdstringOptional

Request

Links multiple entities to a source entity, grouped by target entity type. The source entity type is determined by the path parameter (e.g., /requests/{id} → REQUEST). For implicit reference keys, source and target directions are swapped automatically.

reference_keystringRequired

Reference key of the relationship (e.g., “relates”, “blocks”, “causes”, or “implicit_causes”)

entitieslist of objectsRequired
List of entity groups to link, each specifying a target entity type and its display IDs

Response

Successful response