Skip to main content
POST
Create Tracked Link

Authorizations

api_key
string
header
required

Body

application/json
assetId
string
required

UUID of the asset to link to. e.g. '4f1e2a90-8b3d-4c21-9e07-2a1b3c4d5e6f'

Minimum string length: 1
recipientName
string
required

Who the link is for, as the sender would say it. Shown to the workspace, never to the viewer. e.g. 'Mary Chen, Acme'

Required string length: 1 - 200
opportunityOId
string | null

Deal whose timeline records the link's views. Defaults to the asset's own deal. e.g. 'crmo_abc123'

Minimum string length: 1
notifyOn
enum<string>
default:every_view

When the sender is told: 'every_view' (a same-visitor reload within 30 minutes counts once), 'first_view', or 'off' (views are still counted). e.g. 'every_view'

Available options:
first_view,
every_view,
off
notifyTargets
object | null

Where views are announced: { slack: { channel: { id, name } }, slackDm: { recipients: [email] }, email: { recipients: [email] } }, each optional. Omitted = a Slack DM to the caller.

expiresInDays
integer | null

Days until the link stops opening; null or omitted = never. e.g. 90

Required range: 1 <= x <= 3650

Response

Tracked link created successfully

_metadata
object
required
data
object
required