Documentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Send document to a client
POST https://services.leadconnectorhq.com/proposals/document/send
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion. Version
string
default:"2021-07-28"
required
Version de la API.
Body
locationId
string
default:"hTlkh7t8gujsahgg93"
required
Account Id
documentId
string
default:"hTlkh7t8gujsahgg93"
required
Document Id
documentName
string
default:"new Document"
Document Name
Medium to be used for sending the document Posibles valores: ‘link’, ‘email’
CC Recipient
email
string
default:"jim@gmail.com"
required
Email
id
string
default:"contactId"
required
Contact ID
imageUrl
string
default:"https://example.com/image.jpg"
required
Contact Image URL
contactName
string
default:"Jim Anton"
required
Contact Name
firstName
string
default:"Jim"
required
First Name
lastName
string
default:"Anton"
required
Last Name
sentBy
string
default:"1234567890"
required
Sent ByUser Id
Respuestas
200 - Document sent successfully
success
boolean
default:"True"
required
Success status
Links for all recipients
referenceId
string
default:"550e8400-e29b-41d4-a716-446655440000"
required
Reference ID
documentId
string
default:"c1e87a91-93b2-4b78-821f-85cf0e1f925b"
required
Document ID
recipientId
string
default:"u240JcS0E5qE0ziHnwMm"
required
Recipient ID
entityName
string
default:"contacts"
required
Entity name that the recipient belongs to Posibles valores: ‘contacts’, ‘users’
recipientCategory
string
default:"recipient"
required
Recipient category (recipient, cc, or bcc) Posibles valores: ‘recipient’, ‘cc’, ‘bcc’
documentRevision
number
default:"1"
required
Document revision number
createdBy
string
default:"b6d8fa28-1112-4dc7-b9d2-f22b75a477ea"
required
Created by user ID
deleted
boolean
default:"False"
required
Whether the document is deleted
{
"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
}
]
}
400 - Unprocessable Entity
message
string
default:"Bad Request"
{
"statusCode": 400,
"message": "Bad Request"
}
Ejemplo
curl -X POST 'https://services.leadconnectorhq.com/proposals/document/send' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "hTlkh7t8gujsahgg93",
"documentId": "hTlkh7t8gujsahgg93",
"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": ""
}
},
"sentBy": "1234567890"
}'
