Replace an entity's entire cross-link set

PUT

project

{projectId}

entities

{entityId}

crosslinks

Error

A valid request URL is required to generate request examples

{
  "crosslinks": [
    "<string>"
  ],
  "entityId": "<string>"
}

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Path Parameters

projectId

string

required

entityId

string

required

Query Parameters

bypass_branch_protection

boolean

Explicitly bypass branch protection (including Base) and branch editor groups. Requires an API key owned by an admin for this project. Defaults to false. Item locks, stage policies, field validation and branch lifecycle checks still apply.

Body

application/json

crosslinkIds

string[]

required

The complete set of entities this entity should be cross-linked to. Peers not listed are unlinked; pass an empty array to clear every cross-link.

Maximum array length: 1000

branchId

string

Response

crosslinks

string[]

required

Ids of entities cross-linked to this one that are not deleted on the requested branch. Unordered — cross-links are peer relationships and carry no sort key.

entityId

string

required

Error

A valid request URL is required to generate request examples

{
  "crosslinks": [
    "<string>"
  ],
  "entityId": "<string>"
}

Quickstart

Automations

Flow MCP

Endpoints

Replace an entity's entire cross-link set

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response