Skip to main content
POST
Link records by identifiers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

strategy
enum<string>
default:RESPECT_MAPPING

How to resolve links against existing mappings. Defaults to RESPECT_MAPPING. Determines the linking strategy when records have pre-existing link.

Available options:
RESPECT_MAPPING,
REMOVE_EXISTING

Body

application/json
primaryFieldValue
string
required

Value of primary field to search for.

recordId
string
required

Id of record to search for. Used when looking up a single record.

recordName
string
required

Name of record to search for. (i.e. risk-83, control-39, etc.)

workflowId
string
required

When searching by primary field value, specifies the id of the workflow.

type
enum<string>
Available options:
PRIMARY_FIELD_VALUE,
RECORD_ID,
RECORD_NAME

Response

OK