ClientsOperation links.create

Links create

Add a link; the kind (video, doc, link) is read off the URL when left out.

POST/api/v1/links

Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Body

A JSON object, required. Fields not listed are ignored.

Name	In	Description
`entity_type`required	body	deal or project. One of `deal`, `project`.
`entity_id`required	body	The record.
`title`required	body	Title.
`url`required	body	http or https link.
`kind`	body	video, doc or link. One of `video`, `doc`, `link`.
`client_visible`	body, boolean	Show it on the client portal.

Example

curl

curl -X POST "https://crm.ashwanth.dev/api/v1/links" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_type": "deal",
  "entity_id": "",
  "title": "",
  "url": "",
  "kind": "video",
  "client_visible": false
}'

CLI

sales-engine links create --entity-type deal --entity-id "..." --title "..."

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape

{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.

API key

Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.

Body (JSON)

Every documented field is listed above; leave out the ones you do not need.

Request

POST /api/v1/links