POST · leads:write

Share results

Create a public link for the current lead list after the task finishes.

Set up with your AI assistant

Paste the prompt into your coding assistant. It includes setup steps and a read-only connection check.

Request

Endpoint

POST https://leadsagent.io/api/v1/tasks/{id}/share

Set LEADSAGENT_API_KEY in your local environment. Send it in the X-API-Key header.

Bash · API base URL

export LEADSAGENT_API_BASE="https://leadsagent.io/api/v1"
# For a local backend:
# export LEADSAGENT_API_BASE="http://127.0.0.1:8001/api/v1"

Bash · curl

curl --fail-with-body --silent --show-error --request POST "$LEADSAGENT_API_BASE/tasks/$TASK_ID/share" -H "X-API-Key: $LEADSAGENT_API_KEY"

Replace TASK_ID with data.id from a task response. In PowerShell, use curl.exe and $env:LEADSAGENT_API_KEY. Save JSON in a file and pass --data-binary @request.json.

id (UUID): Required. The task ID.

Anyone with the link can read the list. Share it only with people who should see the data.

Response

data contains task_id and share_url.

Example response

{
  "request_id": "6c4d0c26-8aa3-44b0-a50a-51b832b29465",
  "status": "success",
  "data": {
    "task_id": "73bd1ccb-1a44-4b41-84da-4ea7a5ad03f4",
    "share_url": "https://leadsagent.io/s/example-token",
    "note": "Anyone with this URL can see the lead list without signing in."
  },
  "meta": {}
}

Errors and retries explains status codes and retry rules. A successful request does not mean a background task has finished.

Read as Markdown

← API reference