Skip to main content
POST
Link Entities to Resource

Authorizations

api_key
string
header
required

Body

application/json

Resource, link direction, and the entity oIds to apply

resourceOId
string
required

The resource (doc) oId to link entities to or unlink from

Minimum string length: 1
Example:

"rs_1234567890"

Use add to link entities, remove to unlink entities

Available options:
add,
remove
entityOIds
string[]
required

Library entity oIds to link/unlink — any mix of personas (pe_), use cases (uu_), references (re_), competitors (cp_), proof points (pp_), segments (sg_), objections (oj_), and other library types

Required array length: 1 - 100 elements

Response

Counts of links created/removed plus any skipped oIds

_metadata
object
required
success
boolean
required
resourceOId
string
required
Available options:
add,
remove
linked
number
required

Links created or restored (add) — already-active links are idempotent and do not increment this count

removed
number
required

Links removed (remove)

skipped
string[]
required

Entity oIds that were malformed, unsupported, missing, deleted, or outside this workspace

message
string
required