Skip to main content
POST
/
proposals
/
document
/
send
Send document
curl --request POST \
  --url https://services.leadconnectorhq.com/proposals/document/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "locationId": "hTlkh7t8gujsahgg93",
  "documentId": "hTlkh7t8gujsahgg93",
  "sentBy": "1234567890",
  "documentName": "new Document",
  "medium": "email",
  "ccRecipients": [
    {
      "id": "u240JcS0E5qE0ziHnwMm",
      "email": "jim@gmail.com",
      "imageUrl": "",
      "contactName": "Jim Anton",
      "firstName": "Jim",
      "lastName": "Anton"
    }
  ],
  "notificationSettings": {
    "sender": {
      "fromName": "",
      "fromEmail": ""
    },
    "receive": {
      "subject": "",
      "templateId": ""
    }
  }
}
'
{
  "success": true,
  "links": [
    {
      "referenceId": "550e8400-e29b-41d4-a716-446655440000",
      "documentId": "c1e87a91-93b2-4b78-821f-85cf0e1f925b",
      "recipientId": "u240JcS0E5qE0ziHnwMm",
      "entityName": "contacts",
      "recipientCategory": "recipient",
      "documentRevision": 1,
      "createdBy": "b6d8fa28-1112-4dc7-b9d2-f22b75a477ea",
      "deleted": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Access Token or Private Integration Token

Headers

​
Authorization
string
required

Access Token

Example:

"Bearer 9c48df2694a849b6089f9d0d3513efe"

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Body

application/json
​
locationId
string
required

Location Id

Example:

"hTlkh7t8gujsahgg93"

​
documentId
string
required

Document Id

Example:

"hTlkh7t8gujsahgg93"

​
sentBy
string
required

Sent ByUser Id

Example:

"1234567890"

​
documentName
string

Document Name

Example:

"new Document"

​
medium
enum<string>

Medium to be used for sending the document

Available options:
link,
email
Example:

"email"

​
ccRecipients
object[]

CC Recipient

Example:
[
  {
    "id": "u240JcS0E5qE0ziHnwMm",
    "email": "jim@gmail.com",
    "imageUrl": "",
    "contactName": "Jim Anton",
    "firstName": "Jim",
    "lastName": "Anton"
  }
]
​
notificationSettings
object
Example:
{
  "sender": { "fromName": "", "fromEmail": "" },
  "receive": { "subject": "", "templateId": "" }
}

Response

Document sent successfully

​
success
boolean
required

Success status

Example:

true

​
links
object[]
required

Links for all recipients

Last modified on March 7, 2026