Skip to main content
POST
/
external-links
/
{id}
/
replace
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalSystem": "<string>",
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "externalUrl": "<string>",
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Public API key (format cxp_<tier>_<body>, tier = ro|std|full). Scoped to a single firm. The firm must have public_api in allowedIntegrations.

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
referralId
string<uuid>
required
​
externalSystem
enum<string>
required
Available options:
cloudlex,
morgan_morgan
​
externalId
string
required
Required string length: 1 - 255
​
externalUrl
string<uri>
Maximum string length: 2048

Response

New link created

​
id
string<uuid>
required
​
referralId
string<uuid>
required
​
externalSystem
string
required
​
externalId
string
required
​
createdAt
string<date-time>
required
​
externalUrl
string | null
​
meta
object