POST https://services.leadconnectorhq.com/proposals/document/send
Autorización
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
string
default:"2021-07-28"
required
Versión de la API.
Body
string
default:"hTlkh7t8gujsahgg93"
required
Account Id
string
default:"hTlkh7t8gujsahgg93"
required
Document Id
string
default:"new Document"
Document Name
string
default:"email"
Medium to be used for sending the document Posibles valores: ‘link’, ‘email’
object[]
CC Recipient
object
string
default:"1234567890"
required
Sent ByUser Id
Respuestas
200 - Document sent successfully
200 - Document sent successfully
boolean
default:"True"
required
Success status
object[]
required
Links for all recipients
Show cada item
Show cada item
string
default:"550e8400-e29b-41d4-a716-446655440000"
required
Reference ID
string
default:"c1e87a91-93b2-4b78-821f-85cf0e1f925b"
required
Document ID
string
default:"u240JcS0E5qE0ziHnwMm"
required
Recipient ID
string
default:"contacts"
required
Entity name that the recipient belongs to Posibles valores: ‘contacts’, ‘users’
string
default:"recipient"
required
Recipient category (recipient, cc, or bcc) Posibles valores: ‘recipient’, ‘cc’, ‘bcc’
number
default:"1"
required
Document revision number
string
default:"b6d8fa28-1112-4dc7-b9d2-f22b75a477ea"
required
Created by user ID
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
400 - Unprocessable Entity
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"
}'
const response = await fetch('https://services.leadconnectorhq.com/proposals/document/send', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"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"}),
});
const data = await response.json();
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/proposals/document/send',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"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"},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/proposals/document/send');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'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'}),
]);
$data = json_decode(curl_exec($ch), true);