PNG<
Post the necessary fields for the API to upload files. The files need to be a buffer with the key "fileAttachment". \
\
The allowed file types are: \
\\- JPG\
\- JPEG\
\- PNG\
\- MP4\
\- MPEG\
\- ZIP\
\- RAR\
\- PDF\
\- DOC\
\- DOCX\
\- TXT\
\- MP3\
\- WAV\
\
\
\
The API will return an object with the URLs
```http theme={null}
POST https://services.leadconnectorhq.com/conversations/messages/upload
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Conversation Id
Contact Id
Twilio chat service SID for group SMS uploads
Flag to indicate group SMS upload flow. When true, only 1 file upload is allowed per request.
## Respuestas
Twilio media SIDs for group SMS (when isGroupSms=true)
```json theme={null}
{
"uploadedFiles": {},
"twilioMediaSids": [
"MExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
HTTP Status code of the request Posibles valores: 400, 413, 415
Error message of the request
```json theme={null}
{
"status": 413,
"message": "Failed to upload the files"
}
```
HTTP Status code of the request Posibles valores: 400, 413, 415
Error message of the request
```json theme={null}
{
"status": 413,
"message": "Failed to upload the files"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/conversations/messages/upload' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"conversationId": "ve9EPM428h8vShlRW1KT",
"contactId": "ve9EPM428h8vShlRW1KT",
"locationId": "string",
"attachmentUrls": [
"string"
],
"chatServiceSid": "ISxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"isGroupSms": "true"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/conversations/messages/upload', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"conversationId": "ve9EPM428h8vShlRW1KT", "contactId": "ve9EPM428h8vShlRW1KT", "locationId": "string", "attachmentUrls": ["string"], "chatServiceSid": "ISxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "isGroupSms": "true"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/conversations/messages/upload',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"conversationId": "ve9EPM428h8vShlRW1KT", "contactId": "ve9EPM428h8vShlRW1KT", "locationId": "string", "attachmentUrls": ["string"], "chatServiceSid": "ISxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "isGroupSms": "true"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'conversationId': 've9EPM428h8vShlRW1KT', 'contactId': 've9EPM428h8vShlRW1KT', 'locationId': 'string', 'attachmentUrls': ['string'], 'chatServiceSid': 'ISxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'isGroupSms': 'true'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# User Subscription Change
Source: https://developers.leadwaycrm.com/api-reference/conversations/conversations-user-subscription-change
Process subscription change initiated by a user (admin/agent). Supports individual custom subscription changes and resub all functionality. Legal forms are automatically created for user-initiated res
Process subscription change initiated by a user (admin/agent). Supports individual custom subscription changes and resub all functionality. Legal forms are automatically created for user-initiated resubscribe actions on custom subscriptions.
```http theme={null}
POST https://services.leadconnectorhq.com/conversations/preferences/unsubscriptions/user-change
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
Contact Id
Email address
Subscription action details
Legal reason for the change (required only for resubscribe and resub\_all actions)
Legal description/details
## Respuestas
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/conversations/preferences/unsubscriptions/user-change' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "ve9EPM428h8vShlRW1KT",
"contactId": "OP7z4LCyPACyH5fcEIZa",
"email": "user@example.com",
"legal_reason": "User requested resubscribe via customer service",
"legal_description": "Customer called support on 2024-01-15 requesting to be removed from newsletter"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/conversations/preferences/unsubscriptions/user-change', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "ve9EPM428h8vShlRW1KT", "contactId": "OP7z4LCyPACyH5fcEIZa", "email": "user@example.com", "legal_reason": "User requested resubscribe via customer service", "legal_description": "Customer called support on 2024-01-15 requesting to be removed from newsletter"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/conversations/preferences/unsubscriptions/user-change',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "ve9EPM428h8vShlRW1KT", "contactId": "OP7z4LCyPACyH5fcEIZa", "email": "user@example.com", "legal_reason": "User requested resubscribe via customer service", "legal_description": "Customer called support on 2024-01-15 requesting to be removed from newsletter"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 've9EPM428h8vShlRW1KT', 'contactId': 'OP7z4LCyPACyH5fcEIZa', 'email': 'user@example.com', 'legal_reason': 'User requested resubscribe via customer service', 'legal_description': 'Customer called support on 2024-01-15 requesting to be removed from newsletter'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Import Courses
Source: https://developers.leadwaycrm.com/api-reference/courses/courses-import-courses
Import Courses through public channels
Import Courses through public channels
```http theme={null}
POST https://services.leadconnectorhq.com/courses/courses-exporter/public/import
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Posibles valores: 'published', 'draft'
Posibles valores: 'published', 'draft'
Posibles valores: 'video', 'assignment', 'quiz'
Posibles valores: 'pdf', 'image', 'docx', 'pptx', 'xlsx', 'html', 'dotx', 'epub', 'webp', 'gdoc', 'mp3', 'doc', 'txt', 'zip', 'ppt', 'key', 'htm', 'xls', 'odp', 'odt', 'rtf', 'm4a', 'ods', 'mp4', 'ai', 'avi', 'mov', 'wmv', 'mkv', 'wav', 'flac', 'ogg', 'png', 'jpeg', 'jpg', 'gif', 'bmp', 'tiff', 'svg', 'odg', 'sxw', 'sxc', 'sxi', 'rar', '7z', 'json', 'xml', 'csv', 'md', 'obj', 'stl', 'woff', 'ttf'
Posibles valores: 'published', 'draft'
Posibles valores: 'published', 'draft'
Posibles valores: 'video', 'assignment', 'quiz'
## Respuestas
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/courses/courses-exporter/public/import' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "string",
"userId": "string",
"products": [
{
"title": "string",
"description": "string",
"imageUrl": "string",
"categories": [
{}
],
"instructorDetails": {
"name": "string",
"description": "string"
}
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/courses/courses-exporter/public/import', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "string", "userId": "string", "products": [{"title": "string", "description": "string", "imageUrl": "string", "categories": [{}], "instructorDetails": {"name": "string", "description": "string"}}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/courses/courses-exporter/public/import',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "string", "userId": "string", "products": [{"title": "string", "description": "string", "imageUrl": "string", "categories": [{}], "instructorDetails": {"name": "string", "description": "string"}}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 'string', 'userId': 'string', 'products': [{'title': 'string', 'description': 'string', 'imageUrl': 'string', 'categories': [{}], 'instructorDetails': {'name': 'string', 'description': 'string'}}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Custom Field
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-create-custom-field
Create Custom Field
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
POST https://services.leadconnectorhq.com/custom-fields/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Type of field that you are trying to create Posibles valores: 'TEXT', 'LARGE\_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE\_OPTIONS', 'MULTIPLE\_OPTIONS', 'DATE', 'TEXTBOX\_LIST', 'FILE\_UPLOAD', 'RADIO', 'EMAIL'
Field key. For Custom Object it's formatted as "custom\_object.\{objectKey}.\{fieldKey}". "custom\_object" is a fixed prefix, "\{objectKey}" is your custom object's identifier, and "\{fieldKey}" is the unique field name within that object. Example: "custom\_object.pet.name" for a "name" field in a "pet" custom object.
The key for your custom object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Maximum file limit for uploads. Applicable only for fields with a data type of FILE\_UPLOAD.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
ID of the parent folder
## Respuestas
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Type of field that you are trying to create Posibles valores: 'TEXT', 'LARGE\_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE\_OPTIONS', 'MULTIPLE\_OPTIONS', 'DATE', 'TEXTBOX\_LIST', 'FILE\_UPLOAD', 'RADIO'
ID of the parent folder
Field key. For Custom Object it's formatted as "custom\_object.\{objectKey}.\{fieldKey}". "custom\_object" is a fixed prefix, "\{objectKey}" is your custom object's identifier, and "\{fieldName}" is the unique field name within that object. Example: "custom\_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"field": {
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{
"key": "string",
"label": "string",
"url": "string"
}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
"allowCustomOption": true,
"maxFileLimit": 2,
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/custom-fields/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{
"key": "string",
"label": "string",
"url": "string"
}
],
"acceptedFormats": ".pdf",
"dataType": "TEXT",
"fieldKey": "custom_object.pet.name",
"objectKey": "custom_object.pet",
"maxFileLimit": 2,
"allowCustomOption": true,
"parentId": "string"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "ve9EPM428h8vShlRW1KT", "name": "Name", "description": "string", "placeholder": "string", "showInForms": true, "options": [{"key": "string", "label": "string", "url": "string"}], "acceptedFormats": ".pdf", "dataType": "TEXT", "fieldKey": "custom_object.pet.name", "objectKey": "custom_object.pet", "maxFileLimit": 2, "allowCustomOption": true, "parentId": "string"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/custom-fields/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "ve9EPM428h8vShlRW1KT", "name": "Name", "description": "string", "placeholder": "string", "showInForms": true, "options": [{"key": "string", "label": "string", "url": "string"}], "acceptedFormats": ".pdf", "dataType": "TEXT", "fieldKey": "custom_object.pet.name", "objectKey": "custom_object.pet", "maxFileLimit": 2, "allowCustomOption": true, "parentId": "string"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 've9EPM428h8vShlRW1KT', 'name': 'Name', 'description': 'string', 'placeholder': 'string', 'showInForms': true, 'options': [{'key': 'string', 'label': 'string', 'url': 'string'}], 'acceptedFormats': '.pdf', 'dataType': 'TEXT', 'fieldKey': 'custom_object.pet.name', 'objectKey': 'custom_object.pet', 'maxFileLimit': 2, 'allowCustomOption': true, 'parentId': 'string'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Custom Field Folder
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-create-custom-field-folder
Create Custom Field Folder
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
POST https://services.leadconnectorhq.com/custom-fields/folder
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
The key for your custom object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Field name
Account Id
## Respuestas
Unique identifier of the object
The key for your custom object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Account Id
Field name
```json theme={null}
{
"id": "string",
"objectKey": "custom_object.pet",
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/custom-fields/folder' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"objectKey": "custom_object.pet",
"name": "Name",
"locationId": "ve9EPM428h8vShlRW1KT"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/folder', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"objectKey": "custom_object.pet", "name": "Name", "locationId": "ve9EPM428h8vShlRW1KT"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/custom-fields/folder',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"objectKey": "custom_object.pet", "name": "Name", "locationId": "ve9EPM428h8vShlRW1KT"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'objectKey': 'custom_object.pet', 'name': 'Name', 'locationId': 've9EPM428h8vShlRW1KT'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Custom Field By Id
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-delete-custom-field
Delete Custom Field By Id
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
DELETE https://services.leadconnectorhq.com/custom-fields/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Respuestas
```json theme={null}
{
"succeded": true,
"id": "3v34PM428h8vShlRW1KT",
"key": "custom_object.pet.name"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/custom-fields/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/YOUR_id', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/custom-fields/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Custom Field Folder
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-delete-custom-field-folder
Create Custom Field Folder
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
DELETE https://services.leadconnectorhq.com/custom-fields/folder/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Query parameters
Account Id
## Respuestas
```json theme={null}
{
"succeded": true,
"id": "3v34PM428h8vShlRW1KT",
"key": "custom_object.pet.name"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/custom-fields/folder/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/folder/YOUR_id', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/custom-fields/folder/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Custom Field / Folder By Id
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-get-custom-field-by-id
Get Custom Field / Folder By Id.
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
GET https://services.leadconnectorhq.com/custom-fields/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Respuestas
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Type of field that you are trying to create Posibles valores: 'TEXT', 'LARGE\_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE\_OPTIONS', 'MULTIPLE\_OPTIONS', 'DATE', 'TEXTBOX\_LIST', 'FILE\_UPLOAD', 'RADIO'
ID of the parent folder
Field key. For Custom Object it's formatted as "custom\_object.\{objectKey}.\{fieldKey}". "custom\_object" is a fixed prefix, "\{objectKey}" is your custom object's identifier, and "\{fieldName}" is the unique field name within that object. Example: "custom\_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"field": {
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{
"key": "string",
"label": "string",
"url": "string"
}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
"allowCustomOption": true,
"maxFileLimit": 2,
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/custom-fields/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/YOUR_id', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/custom-fields/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Custom Fields By Object Key
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-get-custom-fields-by-object-key
Get Custom Fields By Object Key
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
GET https://services.leadconnectorhq.com/custom-fields/object-key/{objectKey}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
key of the Object. Must include "custom\_objects." prefix for custom objects. Available on the Custom Objects details Page under settings
## Query parameters
## Respuestas
Custom Fields for the object.
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Type of field that you are trying to create Posibles valores: 'TEXT', 'LARGE\_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE\_OPTIONS', 'MULTIPLE\_OPTIONS', 'DATE', 'TEXTBOX\_LIST', 'FILE\_UPLOAD', 'RADIO'
ID of the parent folder
Field key. For Custom Object it's formatted as "custom\_object.\{objectKey}.\{fieldKey}". "custom\_object" is a fixed prefix, "\{objectKey}" is your custom object's identifier, and "\{fieldName}" is the unique field name within that object. Example: "custom\_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
Custom Fields folder for the object.
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Type of field that you are trying to create Posibles valores: 'TEXT', 'LARGE\_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE\_OPTIONS', 'MULTIPLE\_OPTIONS', 'DATE', 'TEXTBOX\_LIST', 'FILE\_UPLOAD', 'RADIO'
ID of the parent folder
Field key. For Custom Object it's formatted as "custom\_object.\{objectKey}.\{fieldKey}". "custom\_object" is a fixed prefix, "\{objectKey}" is your custom object's identifier, and "\{fieldName}" is the unique field name within that object. Example: "custom\_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"fields": [
{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
"allowCustomOption": true,
"maxFileLimit": 2,
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
],
"folders": [
{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
// truncado: 7 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/custom-fields/object-key/YOUR_objectKey' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/object-key/YOUR_objectKey', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/custom-fields/object-key/YOUR_objectKey',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Custom Field By Id
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-update-custom-field
Update Custom Field By Id
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
PUT https://services.leadconnectorhq.com/custom-fields/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Body
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field. Important: Providing options will completely replace the existing options array. You must include all existing options alongside any new options you wish to add. Removal of options is not supported through this update. Applicable only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST types.
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Maximum file limit for uploads. Applicable only for fields with a data type of FILE\_UPLOAD.
## Respuestas
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Type of field that you are trying to create Posibles valores: 'TEXT', 'LARGE\_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE\_OPTIONS', 'MULTIPLE\_OPTIONS', 'DATE', 'TEXTBOX\_LIST', 'FILE\_UPLOAD', 'RADIO'
ID of the parent folder
Field key. For Custom Object it's formatted as "custom\_object.\{objectKey}.\{fieldKey}". "custom\_object" is a fixed prefix, "\{objectKey}" is your custom object's identifier, and "\{fieldName}" is the unique field name within that object. Example: "custom\_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"field": {
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{
"key": "string",
"label": "string",
"url": "string"
}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
"allowCustomOption": true,
"maxFileLimit": 2,
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/custom-fields/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{
"key": "string",
"label": "string",
"url": "string"
}
],
"acceptedFormats": ".pdf",
"maxFileLimit": 2
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/YOUR_id', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "ve9EPM428h8vShlRW1KT", "name": "Name", "description": "string", "placeholder": "string", "showInForms": true, "options": [{"key": "string", "label": "string", "url": "string"}], "acceptedFormats": ".pdf", "maxFileLimit": 2}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/custom-fields/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "ve9EPM428h8vShlRW1KT", "name": "Name", "description": "string", "placeholder": "string", "showInForms": true, "options": [{"key": "string", "label": "string", "url": "string"}], "acceptedFormats": ".pdf", "maxFileLimit": 2},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 've9EPM428h8vShlRW1KT', 'name': 'Name', 'description': 'string', 'placeholder': 'string', 'showInForms': true, 'options': [{'key': 'string', 'label': 'string', 'url': 'string'}], 'acceptedFormats': '.pdf', 'maxFileLimit': 2}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Custom Field Folder Name
Source: https://developers.leadwaycrm.com/api-reference/custom-fields/custom-fields-update-custom-field-folder
Create Custom Field Folder
!
\
\
\
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
\
\
\
\
```http theme={null}
PUT https://services.leadconnectorhq.com/custom-fields/folder/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Body
Field name
Account Id
## Respuestas
Unique identifier of the object
The key for your custom object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Account Id
Field name
```json theme={null}
{
"id": "string",
"objectKey": "custom_object.pet",
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/custom-fields/folder/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "Name",
"locationId": "ve9EPM428h8vShlRW1KT"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-fields/folder/YOUR_id', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "Name", "locationId": "ve9EPM428h8vShlRW1KT"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/custom-fields/folder/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "Name", "locationId": "ve9EPM428h8vShlRW1KT"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'Name', 'locationId': 've9EPM428h8vShlRW1KT'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Custom Menu Link
Source: https://developers.leadwaycrm.com/api-reference/custom-menus/custom-menus-create-custom-menu
Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2
Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to [https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2](https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2)
```http theme={null}
POST https://services.leadconnectorhq.com/custom-menus/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Title of the custom menu
URL of the custom menu
Icon information for the custom menu
Whether the menu must be displayed on the agency's level
Whether the menu must be displayed for accounts level
Whether the menu must be displayed to all accounts
Mode for opening the menu link Posibles valores: 'iframe', 'new\_tab', 'current\_tab'
List of account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false
Which user-roles should the menu be accessible to? Posibles valores: 'all', 'admin', 'user'
Whether to allow camera access (only for iframe mode)
Whether to allow microphone access (only for iframe mode)
## Respuestas
Single Custom menu link object
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/custom-menus/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"title": "Custom Menu",
"url": "https://custom-menus.com/",
"showOnCompany": true,
"showOnLocation": true,
"showToAllLocations": true,
"openMode": "iframe",
"locations": [
"gfWreTIHL8pDbggBb7af",
"67WreTIHL8pDbggBb7ty"
],
"userRole": "all",
"allowCamera": false,
"allowMicrophone": false
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-menus/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"title": "Custom Menu", "url": "https://custom-menus.com/", "showOnCompany": true, "showOnLocation": true, "showToAllLocations": true, "openMode": "iframe", "locations": ["gfWreTIHL8pDbggBb7af", "67WreTIHL8pDbggBb7ty"], "userRole": "all", "allowCamera": false, "allowMicrophone": false}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/custom-menus/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"title": "Custom Menu", "url": "https://custom-menus.com/", "showOnCompany": true, "showOnLocation": true, "showToAllLocations": true, "openMode": "iframe", "locations": ["gfWreTIHL8pDbggBb7af", "67WreTIHL8pDbggBb7ty"], "userRole": "all", "allowCamera": false, "allowMicrophone": false},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'title': 'Custom Menu', 'url': 'https://custom-menus.com/', 'showOnCompany': true, 'showOnLocation': true, 'showToAllLocations': true, 'openMode': 'iframe', 'locations': ['gfWreTIHL8pDbggBb7af', '67WreTIHL8pDbggBb7ty'], 'userRole': 'all', 'allowCamera': false, 'allowMicrophone': false}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Custom Menu Link
Source: https://developers.leadwaycrm.com/api-reference/custom-menus/custom-menus-delete-custom-menu
Removes a specific custom menu from the system. This operation requires authentication and proper permissions. The custom menu is identified by its unique ID, and the operation is performed within the
Removes a specific custom menu from the system. This operation requires authentication and proper permissions. The custom menu is identified by its unique ID, and the operation is performed within the context of a specific company.
```http theme={null}
DELETE https://services.leadconnectorhq.com/custom-menus/{customMenuId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the custom menu to delete
## Respuestas
Indicates whether the custom menu was successfully deleted
A message providing additional information about the deletion operation
The ID of the deleted custom menu
Timestamp of when the deletion was performed
```json theme={null}
{
"success": true,
"message": "Custom menu successfully deleted",
"deletedMenuId": "12345abcde",
"deletedAt": "2023-09-12T15:30:45.123Z"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Custom Menu Link
Source: https://developers.leadwaycrm.com/api-reference/custom-menus/custom-menus-get-custom-menu-by-id
Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata
Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata
```http theme={null}
GET https://services.leadconnectorhq.com/custom-menus/{customMenuId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Unique identifier of the custom menu
## Respuestas
Single Custom menu link object
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Custom Menu Links
Source: https://developers.leadwaycrm.com/api-reference/custom-menus/custom-menus-get-custom-menus
Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata
Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata. The response can be tailored using query parameters for filtering, sorting, and pagination.
```http theme={null}
GET https://services.leadconnectorhq.com/custom-menus/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Unique identifier of the account
Number of items to skip for pagination
Maximum number of items to return
Search query to filter custom menus by name, supports partial || full names
Filter to show only agency-level menu links. When omitted, fetches both agency and account menu links. Ignored if locationId is provided
## Respuestas
Array of custom menu links
Unique identifier for the custom menu
Icon information for the menu item
Title of the custom menu
URL of the custom menu
Order of the custom menu
Filter to show only agency-level menu links. When omitted, fetches both agency and account menu links. Ignored if locationId is provided
Whether the menu must be displayed for accounts level
Whether the menu must be displayed to all accounts
List of account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false
Mode for opening the menu link Posibles valores: 'iframe', 'new\_tab', 'current\_tab'
Which user-roles should the menu be accessible to? Posibles valores: 'all', 'admin', 'user'
Indicates if camera access is allowed for this menu
Indicates if microphone access is allowed for this menu
Total number of custom menu records
```json theme={null}
{
"customMenus": [
{
"id": "12345",
"title": "Dashboard",
"url": "/dashboard",
"order": 1,
"showOnCompany": true,
"showOnLocation": true,
"showToAllLocations": true,
"locations": [
"gfWreTIHL8pDbggBb7af",
"67WreTIHL8pDbggBb7ty"
],
"openMode": "iframe",
"userRole": "all",
"allowCamera": false,
"allowMicrophone": false
}
],
"totalLinks": 100
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/custom-menus/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-menus/', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/custom-menus/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Custom Menu Link
Source: https://developers.leadwaycrm.com/api-reference/custom-menus/custom-menus-update-custom-menu
Updates an existing custom menu for a given company. Requires authentication and proper permissions.
Updates an existing custom menu for a given company. Requires authentication and proper permissions.
```http theme={null}
PUT https://services.leadconnectorhq.com/custom-menus/{customMenuId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the custom menu to update
## Body
Title of the custom menu
URL of the custom menu
Icon information for the custom menu
Whether the menu must be displayed on the agency's level
Whether the menu must be displayed for accounts level
Whether the menu must be displayed to all accounts
Mode for opening the menu link Posibles valores: 'iframe', 'new\_tab', 'current\_tab'
List of account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false
Which user-roles should the menu be accessible to? Posibles valores: 'all', 'admin', 'user'
Whether to allow camera access (only for iframe mode)
Whether to allow microphone access (only for iframe mode)
## Respuestas
Status of update
Updated custom menu link
```json theme={null}
{
"success": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"title": "Custom Menu",
"url": "https://custom-menus.com/",
"showOnCompany": true,
"showOnLocation": true,
"showToAllLocations": true,
"openMode": "iframe",
"locations": [
"gfWreTIHL8pDbggBb7af",
"67WreTIHL8pDbggBb7ty"
],
"userRole": "all",
"allowCamera": false,
"allowMicrophone": false
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"title": "Custom Menu", "url": "https://custom-menus.com/", "showOnCompany": true, "showOnLocation": true, "showToAllLocations": true, "openMode": "iframe", "locations": ["gfWreTIHL8pDbggBb7af", "67WreTIHL8pDbggBb7ty"], "userRole": "all", "allowCamera": false, "allowMicrophone": false}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"title": "Custom Menu", "url": "https://custom-menus.com/", "showOnCompany": true, "showOnLocation": true, "showToAllLocations": true, "openMode": "iframe", "locations": ["gfWreTIHL8pDbggBb7af", "67WreTIHL8pDbggBb7ty"], "userRole": "all", "allowCamera": false, "allowMicrophone": false},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'title': 'Custom Menu', 'url': 'https://custom-menus.com/', 'showOnCompany': true, 'showOnLocation': true, 'showToAllLocations': true, 'openMode': 'iframe', 'locations': ['gfWreTIHL8pDbggBb7af', '67WreTIHL8pDbggBb7ty'], 'userRole': 'all', 'allowCamera': false, 'allowMicrophone': false}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Forms
Source: https://developers.leadwaycrm.com/api-reference/email-forms/email-forms-get-forms
Get Forms
Get Forms
```http theme={null}
GET https://services.leadconnectorhq.com/forms/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Limit Per Page records count. will allow maximum up to 50 and default will be 10
## Respuestas
Total number of forms
```json theme={null}
{
"forms": [
{
"id": "YSWdvS4Is98wtIDGnpmI",
"name": "Form 1",
"locationId": "ve9EPM428h8vShlRW1KT"
}
],
"total": "20"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/forms/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/forms/', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/forms/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Forms Submissions
Source: https://developers.leadwaycrm.com/api-reference/email-forms/email-forms-get-forms-submissions
Get Forms Submissions
Get Forms Submissions
```http theme={null}
GET https://services.leadconnectorhq.com/forms/submissions
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Page No. By default it will be 1
Limit Per Page records count. will allow maximum up to 100 and default will be 20
Filter submission by form id
Filter by contactId, name, email or phone no.
Get submission by starting of this date. By default it will be same date of last month(YYYY-MM-DD).
Get submission by ending of this date. By default it will be current date(YYYY-MM-DD).
## Respuestas
```json theme={null}
{
"submissions": [
{
"id": "38303ec7-629a-49e2-888a-cf8bf0b1f97e",
"contactId": "DWQ45t2IPVxi9LDu1wBl",
"createdAt": "2021-06-23T06:07:04.000Z",
"formId": "YSWdvS4Is98wtIDGnpmI",
"name": "test",
"email": "test@test.com",
"others": {
"__submissions_other_field__": "john@deo.com",
"__custom_field_id__": "20",
"eventData": {},
"fieldsOriSequance": [
"full_name",
"first_name",
"last_name",
"phone",
"email"
]
}
}
],
"meta": {
"total": 1,
"currentPage": 1
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/forms/submissions' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/forms/submissions', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/forms/submissions',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Upload files to custom fields
Source: https://developers.leadwaycrm.com/api-reference/email-forms/email-forms-upload-to-custom-fields
Post the necessary fields for the API to upload files. The files need to be a buffer with the key "< custom_field_id >_< file_id >".
Here custom field id is the ID of your custom field and file
Post the necessary fields for the API to upload files. The files need to be a buffer with the key "\< custom\_field\_id >\_\< file\_id >". \
Here custom field id is the ID of your custom field and file id is a randomly generated id (or uuid) \
There is support for multiple file uploads as well. Have multiple fields in the format mentioned.\
File size is limited to 50 MB.\
\
The allowed file types are: \
\\- PDF\
\- DOCX\
\- DOC\
\- JPG\
\- JPEG\
\- PNG\
\- GIF\
\- CSV\
\- XLSX\
\- XLS\
\- MP4\
\- MPEG\
\- ZIP\
\- RAR\
\- TXT\
\- SVG\
\
\
\
The API will return the updated contact object.
```http theme={null}
POST https://services.leadconnectorhq.com/forms/upload-custom-files
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Contact ID to upload the file to.
Account ID of the contact.
## Respuestas
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/forms/upload-custom-files' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/forms/upload-custom-files', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/forms/upload-custom-files',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Redirect
Source: https://developers.leadwaycrm.com/api-reference/funnels/funnels-create-redirect
The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that the required information is provided in the
The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that the required information is provided in the request payload.
```http theme={null}
POST https://services.leadconnectorhq.com/funnels/lookup/redirect
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Posibles valores: 'funnel', 'website', 'url', 'all'
## Respuestas
Data containing details of the created redirect
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/funnels/lookup/redirect' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "6p2RxpgtMKQwO3E6IUaT",
"domain": "example.com",
"path": "/Hello",
"target": "https://www.google.com",
"action": "URL"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/funnels/lookup/redirect', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "6p2RxpgtMKQwO3E6IUaT", "domain": "example.com", "path": "/Hello", "target": "https://www.google.com", "action": "URL"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/funnels/lookup/redirect',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "6p2RxpgtMKQwO3E6IUaT", "domain": "example.com", "path": "/Hello", "target": "https://www.google.com", "action": "URL"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': '6p2RxpgtMKQwO3E6IUaT', 'domain': 'example.com', 'path': '/Hello', 'target': 'https://www.google.com', 'action': 'URL'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Redirect By Id
Source: https://developers.leadwaycrm.com/api-reference/funnels/funnels-delete-redirect-by-id
The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier. Use this endpoint to delete a URL redirect with the specified ID using details provided i
The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier. Use this endpoint to delete a URL redirect with the specified ID using details provided in the request payload.
```http theme={null}
DELETE https://services.leadconnectorhq.com/funnels/lookup/redirect/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Query parameters
## Respuestas
Status of the delete operation
```json theme={null}
{
"data": {
"status": "ok"
}
}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/funnels/lookup/redirect/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/funnels/lookup/redirect/YOUR_id', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/funnels/lookup/redirect/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch List of Redirects
Source: https://developers.leadwaycrm.com/api-reference/funnels/funnels-fetch-redirects-list
Retrieves a list of all URL redirects based on the given query parameters.
Retrieves a list of all URL redirects based on the given query parameters.
```http theme={null}
GET https://services.leadconnectorhq.com/funnels/lookup/redirect/list
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
## Respuestas
Object containing the count of redirects and an array of redirect data
```json theme={null}
{
"data": {
"count": 42,
"data": []
}
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/funnels/lookup/redirect/list' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/funnels/lookup/redirect/list', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/funnels/lookup/redirect/list',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch List of Funnels
Source: https://developers.leadwaycrm.com/api-reference/funnels/funnels-getfunnels
Retrieves a list of all funnels based on the given query parameters.
Retrieves a list of all funnels based on the given query parameters.
```http theme={null}
GET https://services.leadconnectorhq.com/funnels/funnel/list
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
## Respuestas
```json theme={null}
{
"funnels": {
"_id": "SkIDfu0S4m3NYQyvWHC6",
"dateAdded": "2024-04-29T15:00:05.681Z",
"dateUpdated": "2024-04-29T15:00:28.465Z",
"deleted": false,
"domainId": "",
"locationId": "ojQjykmwNIU88vfsfzvH",
"name": "Chaitanya Copy",
"orderFormVersion": 2,
"originId": "hAmyh7jrJH5FfEEKAJ9z",
"steps": [
{
"id": "f5d178c0-8bbb-4cd4-927c-691c68a62c59",
"name": "Step 1",
"originId": "80b2f227-5bc8-4ca5-980d-817745ea4e8b",
"pages": [
"2IhBmBcQRx9JXV1JZsRt"
],
"products": [],
"sequence": 1,
"type": "optin_funnel_page",
"url": "/newtestifypath"
}
],
"type": "funnel",
"updatedAt": "2024-04-29T15:00:34.233Z",
"faviconUrl": "",
"globalSectionVersion": 1,
"globalSectionsPath": "funnel/SkIDfu0S4m3NYQyvWHC6/global-sections-1",
"globalSectionsUrl": "https://firebasestorage.googleapis.com/v0/b/leadway-staging.appspot.com/o/funnel%2FSkIDfu0S4m3NYQyvWHC6%2Fglobal-sections-1?alt=media&token=9cc5c211-093b-4751-aeba-19282ac92955",
"isStoreActive": false,
"trackingCodeBody": "",
"trackingCodeHead": "",
"url": "/chaitanya"
},
"count": 24,
"traceId": "03774d31-a57e-4b4f-95c7-315ce61969f1"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/funnels/funnel/list' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/funnels/funnel/list', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/funnels/funnel/list',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch list of funnel pages
Source: https://developers.leadwaycrm.com/api-reference/funnels/funnels-getpagesbyfunnelid
Retrieves a list of all funnel pages based on the given query parameters.
Retrieves a list of all funnel pages based on the given query parameters.
```http theme={null}
GET https://services.leadconnectorhq.com/funnels/page
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
## Respuestas
```json theme={null}
{
"_id": "0yJbP3q7t7pLmeTWRAE2",
"locationId": "ojQjykmwNIU88vfsfzvH",
"funnelId": "iucJ6TdFZiddhq9f6znh",
"name": "Home",
"stepId": "343bf634-3aa6-4ade-b963-2d3cd0bf2ede",
"deleted": false,
"updatedAt": "2024-04-18T12:25:23.029Z"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/funnels/page' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/funnels/page', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/funnels/page',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch count of funnel pages
Source: https://developers.leadwaycrm.com/api-reference/funnels/funnels-getpagescountbyfunnelid
Retrieves count of all funnel pages based on the given query parameters.
Retrieves count of all funnel pages based on the given query parameters.
```http theme={null}
GET https://services.leadconnectorhq.com/funnels/page/count
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
## Respuestas
```json theme={null}
{
"count": 20
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/funnels/page/count' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/funnels/page/count', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/funnels/page/count',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Redirect By Id
Source: https://developers.leadwaycrm.com/api-reference/funnels/funnels-update-redirect-by-id
The "Update Redirect By Id" API Allows updating an existing URL redirect in the system. Use this endpoint to modify a URL redirect with the specified ID using details provided in the request payload.
The "Update Redirect By Id" API Allows updating an existing URL redirect in the system. Use this endpoint to modify a URL redirect with the specified ID using details provided in the request payload.
```http theme={null}
PATCH https://services.leadconnectorhq.com/funnels/lookup/redirect/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Body
Posibles valores: 'funnel', 'website', 'url', 'all'
## Respuestas
Data containing details of the updated redirect
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PATCH 'https://services.leadconnectorhq.com/funnels/lookup/redirect/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"target": "https://www.google.com",
"action": "URL",
"locationId": "6p2RxpgtMKQwO3E6IUaT"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/funnels/lookup/redirect/YOUR_id', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"target": "https://www.google.com", "action": "URL", "locationId": "6p2RxpgtMKQwO3E6IUaT"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/funnels/lookup/redirect/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"target": "https://www.google.com", "action": "URL", "locationId": "6p2RxpgtMKQwO3E6IUaT"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'target': 'https://www.google.com', 'action': 'URL', 'locationId': '6p2RxpgtMKQwO3E6IUaT'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Manage Auto payment for an schedule invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-auto-payment-invoice-schedule
API to manage auto payment for a schedule
API to manage auto payment for a schedule
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}/auto-payment
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Schedule Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
auto-payment configuration
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/auto-payment' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"id": "string"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/auto-payment', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "id": "string"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/auto-payment',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "id": "string"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'id': 'string'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Cancel an scheduled invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-cancel-invoice-schedule
API to cancel a scheduled invoice by schedule id
API to cancel a scheduled invoice by schedule id
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}/cancel
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Schedule Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/cancel' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/cancel',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Estimate Template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-create-estimate-template
Create a new estimate template
Create a new estimate template
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/estimate/template
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id or Agency Id
Posibles valores: 'account'
Estimate Name
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Currency code
An array of items for the estimate.
livemode for estimate
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Terms notes, Also supports HTML markups
Title for the estimate
Automatic taxes enabled for the Estimate
Meta data for the estimate
When sending estimate directly while saving
Prefix for the estimate number
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
miscellaneous charges for the estimate
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 48 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate/template' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "Home Service Estimate Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "USD",
"items": [
[]
],
"liveMode": true,
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "This is a default terms.
",
"title": "ESTIMATE",
"automaticTaxesEnabled": true,
"meta": {
"key": "value"
},
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/template', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [[]], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/estimate/template',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [[]], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'Home Service Estimate Template', 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'USD', 'items': [[]], 'liveMode': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'This is a default terms.
', 'title': 'ESTIMATE', 'automaticTaxesEnabled': true, 'meta': {'key': 'value'}, 'estimateNumberPrefix': 'EST-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-create-invoice
API to create an invoice
API to create an invoice
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Invoice Name
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Currency code
An array of items for the invoice.
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Terms notes, Also supports HTML markups
Title for the invoice
Contact information to send the invoice to
Invoice Number
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Email Address
cc to be kept in any sent out emails
bcc to be kept in any sent out emails
Contact Phone Number
Automatic taxes enabled for the Invoice
split invoice into payment schedule summing up to full invoice amount
late fees configuration
tips configuration for the invoice
prefix for invoice number
Payment Methods for Invoices
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
miscellaneous charges for the invoice
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
"invoiceItems": [
// truncado: 20 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "USD",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true
}
],
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "This is a default terms.
",
"title": "INVOICE",
"invoiceNumber": "1001",
"issueDate": "2023-01-01",
"dueDate": "2023-01-14",
"sentTo": {
"email": [
"alex@example.com"
],
"emailCc": [
"alex@example.com"
],
"emailBcc": [
"alex@example.com"
],
"phoneNo": [
"+1-214-559-6993"
]
},
"liveMode": true,
"automaticTaxesEnabled": true,
"invoiceNumberPrefix": "INV-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "New Invoice", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "INVOICE", "invoiceNumber": "1001", "issueDate": "2023-01-01", "dueDate": "2023-01-14", "sentTo": {"email": ["alex@example.com"], "emailCc": ["alex@example.com"], "emailBcc": ["alex@example.com"], "phoneNo": ["+1-214-559-6993"]}, "liveMode": true, "automaticTaxesEnabled": true, "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "New Invoice", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "INVOICE", "invoiceNumber": "1001", "issueDate": "2023-01-01", "dueDate": "2023-01-14", "sentTo": {"email": ["alex@example.com"], "emailCc": ["alex@example.com"], "emailBcc": ["alex@example.com"], "phoneNo": ["+1-214-559-6993"]}, "liveMode": true, "automaticTaxesEnabled": true, "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'New Invoice', 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'USD', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'This is a default terms.
', 'title': 'INVOICE', 'invoiceNumber': '1001', 'issueDate': '2023-01-01', 'dueDate': '2023-01-14', 'sentTo': {'email': ['alex@example.com'], 'emailCc': ['alex@example.com'], 'emailBcc': ['alex@example.com'], 'phoneNo': ['+1-214-559-6993']}, 'liveMode': true, 'automaticTaxesEnabled': true, 'invoiceNumberPrefix': 'INV-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Invoice from Estimate
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-create-invoice-from-estimate
Create a new invoice from an existing estimate
Create a new invoice from an existing estimate
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/estimate/{estimateId}/invoice
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Estimate Id
## Body
Account Id or Agency Id
Posibles valores: 'account'
Mark Estimate as Invoiced
Version of the update request Posibles valores: 'v1', 'v2'
## Respuestas
Estimate details
Invoice details
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/invoice' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"markAsInvoiced": true,
"version": "v2"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/invoice', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "markAsInvoiced": true, "version": "v2"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/invoice',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "markAsInvoiced": true, "version": "v2"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'markAsInvoiced': true, 'version': 'v2'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Invoice Schedule
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-create-invoice-schedule
API to create an invoice Schedule
API to create an invoice Schedule
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/schedule
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Contact ID
Contact Name
Contact Phone Number
Contact Email
Secondary email addresses for the contact to be saved
Contact Company Name
Address Line 1
Address Line 2
City
State
Country Code
Postal Code
Custom Values
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Automatic taxes enabled for the Invoice
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Configuration for tips on invoices
Late fees configuration for the invoices
prefix for invoice number
Payment Methods for Invoices
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
miscellaneous charges for the invoice
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "string",
"contactDetails": {
"id": "6578278e879ad2646715ba9c",
"name": "Alex",
"phoneNo": "+1234567890",
"email": "alex@example.com",
"additionalEmails": [
{
"email": "alex@example.com"
}
],
"companyName": "ABC Corp.",
"address": {
"addressLine1": "9931 Beechwood",
"addressLine2": "Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "US",
"postalCode": "559-6993"
},
"customFields": [
"string"
]
},
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"liveMode": true,
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "string",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true
}
],
"automaticTaxesEnabled": true,
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "string",
"title": "string",
"invoiceNumberPrefix": "INV-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "string", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "schedule": {"executeAt": "string", "rrule": {"intervalType": "monthly", "interval": 2, "startDate": "2023-01-01", "startTime": "20:45:00", "endDate": "2029-11-01", "endTime": "18:45:00", "dayOfMonth": 15, "dayOfWeek": "mo", "numOfWeek": -1, "monthOfYear": "jan", "count": 10, "daysBefore": 5, "useStartAsPrimaryUserAccepted": true, "endType": "by"}}, "liveMode": true, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "string", "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/schedule',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "string", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "schedule": {"executeAt": "string", "rrule": {"intervalType": "monthly", "interval": 2, "startDate": "2023-01-01", "startTime": "20:45:00", "endDate": "2029-11-01", "endTime": "18:45:00", "dayOfMonth": 15, "dayOfWeek": "mo", "numOfWeek": -1, "monthOfYear": "jan", "count": 10, "daysBefore": 5, "useStartAsPrimaryUserAccepted": true, "endType": "by"}}, "liveMode": true, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "string", "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'string', 'contactDetails': {'id': '6578278e879ad2646715ba9c', 'name': 'Alex', 'phoneNo': '+1234567890', 'email': 'alex@example.com', 'additionalEmails': [{'email': 'alex@example.com'}], 'companyName': 'ABC Corp.', 'address': {'addressLine1': '9931 Beechwood', 'addressLine2': 'Beechwood', 'city': 'St. Houston', 'state': 'TX', 'countryCode': 'US', 'postalCode': '559-6993'}, 'customFields': ['string']}, 'schedule': {'executeAt': 'string', 'rrule': {'intervalType': 'monthly', 'interval': 2, 'startDate': '2023-01-01', 'startTime': '20:45:00', 'endDate': '2029-11-01', 'endTime': '18:45:00', 'dayOfMonth': 15, 'dayOfWeek': 'mo', 'numOfWeek': -1, 'monthOfYear': 'jan', 'count': 10, 'daysBefore': 5, 'useStartAsPrimaryUserAccepted': true, 'endType': 'by'}}, 'liveMode': true, 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'string', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'automaticTaxesEnabled': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'string', 'title': 'string', 'invoiceNumberPrefix': 'INV-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-create-invoice-template
API to create a template
API to create a template
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/template
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Name of the template
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Automatic taxes enabled for the Invoice
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Template title
Configuration for tips on invoices
Late fees configuration for the invoices
prefix for invoice number
Payment Methods for Invoices
attachments for the invoice
miscellaneous charges for the invoice
## Respuestas
Template Id
Account Id or Agency Id
Posibles valores: 'account'
Name of the Template
Business Details
Currency
Discount
Invoice Items
prefix for invoice number
Total Amount
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Template",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"currency": "USD",
"discount": {
"type": "percentage",
"value": 0
},
"items": [
{
"taxes": [],
"_id": "c6tZZU0rJBf30ZXx9Gli",
"productId": "c6tZZU0rJBf30ZXx9Gli",
"priceId": "c6tZZU0rJBf30ZXx9Gli",
"currency": "USD",
"name": "Macbook Pro",
"qty": 1,
"amount": 999
}
],
"invoiceNumberPrefix": "INV-",
"total": 999,
"createdAt": "2023-12-12T09:27:42.355Z",
"updatedAt": "2023-12-12T09:27:42.355Z"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/template' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"internal": true,
"name": "New Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "string",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true
}
],
"automaticTaxesEnabled": true,
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "string",
"title": "New Template",
"invoiceNumberPrefix": "INV-",
"attachments": [
"string"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/template', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "internal": true, "name": "New Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "New Template", "invoiceNumberPrefix": "INV-", "attachments": ["string"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/template',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "internal": true, "name": "New Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "New Template", "invoiceNumberPrefix": "INV-", "attachments": ["string"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'internal': true, 'name': 'New Template', 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'string', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'automaticTaxesEnabled': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'string', 'title': 'New Template', 'invoiceNumberPrefix': 'INV-', 'attachments': ['string']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create New Estimate
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-create-new-estimate
Create a new estimate with the provided details
Create a new estimate with the provided details
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/estimate
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id or Agency Id
Posibles valores: 'account'
Estimate Name
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Currency code
An array of items for the estimate.
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Attachments for the line item
livemode for estimate
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Terms notes, Also supports HTML markups
Title for the estimate
Contact information to send the estimate to
Estimate Number, if not specified will take in the next valid estimate number
issue date estimate
expiry date estimate
Email and sent to details for the estimate
Automatic taxes enabled for the Estimate
Meta data for the estimate
When sending estimate directly while saving
frequency settings for the estimate
Prefix for the estimate number
User Id
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
Auto invoice for the estimate
miscellaneous charges for the estimate
Payment Schedule Config for the estimate
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
Company identifier associated with the estimate
Contact details for the estimate
Date when the estimate was issued
Date when the estimate expires
User who sent the estimate
Indicates if automatic taxes were calculated
Additional metadata associated with the estimate
History of actions taken on the estimate
Recipient details for the estimate
Frequency settings for recurring estimates
Timestamp when the estimate was last visited
Total amount in USD
Auto-invoice settings for the estimate
Trace ID for logging and debugging
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 86 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "Home Service Estimate",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "USD",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true,
"attachments": [
"https://example.com/file1.jpg",
"https://example.com/file2.png"
]
}
],
"liveMode": true,
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "This is a default terms.
",
"title": "ESTIMATE",
"estimateNumber": 1001,
"issueDate": "2024-08-07",
"expiryDate": "2024-08-10",
"automaticTaxesEnabled": true,
"meta": {
"key": "value"
},
"estimateNumberPrefix": "EST-",
"userId": "6578278e879ad2646715ba9c",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
],
"autoInvoice": {
"enabled": true,
"directPayments": true
}
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true, "attachments": ["https://example.com/file1.jpg", "https://example.com/file2.png"]}], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "estimateNumber": 1001, "issueDate": "2024-08-07", "expiryDate": "2024-08-10", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "userId": "6578278e879ad2646715ba9c", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}], "autoInvoice": {"enabled": true, "directPayments": true}}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/estimate',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true, "attachments": ["https://example.com/file1.jpg", "https://example.com/file2.png"]}], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "estimateNumber": 1001, "issueDate": "2024-08-07", "expiryDate": "2024-08-10", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "userId": "6578278e879ad2646715ba9c", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}], "autoInvoice": {"enabled": true, "directPayments": true}},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'Home Service Estimate', 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'USD', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true, 'attachments': ['https://example.com/file1.jpg', 'https://example.com/file2.png']}], 'liveMode': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'This is a default terms.
', 'title': 'ESTIMATE', 'estimateNumber': 1001, 'issueDate': '2024-08-07', 'expiryDate': '2024-08-10', 'automaticTaxesEnabled': true, 'meta': {'key': 'value'}, 'estimateNumberPrefix': 'EST-', 'userId': '6578278e879ad2646715ba9c', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}], 'autoInvoice': {'enabled': true, 'directPayments': true}}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Estimate
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-delete-estimate
Delete an existing estimate
Delete an existing estimate
```http theme={null}
DELETE https://services.leadconnectorhq.com/invoices/estimate/{estimateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Estimate Id
## Body
Account Id or Agency Id
Posibles valores: 'account'
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
Company identifier associated with the estimate
Contact details for the estimate
Date when the estimate was issued
Date when the estimate expires
User who sent the estimate
Indicates if automatic taxes were calculated
Additional metadata associated with the estimate
History of actions taken on the estimate
Recipient details for the estimate
Frequency settings for recurring estimates
Timestamp when the estimate was last visited
Total amount in USD
Auto-invoice settings for the estimate
Trace ID for logging and debugging
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 86 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Estimate Template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-delete-estimate-template
Delete an existing estimate template
Delete an existing estimate template
```http theme={null}
DELETE https://services.leadconnectorhq.com/invoices/estimate/template/{templateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Template Id
## Body
Account Id or Agency Id
Posibles valores: 'account'
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 48 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/invoices/estimate/template/YOUR_templateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/template/YOUR_templateId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/invoices/estimate/template/YOUR_templateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-delete-invoice
API to delete invoice by invoice id
API to delete invoice by invoice id
```http theme={null}
DELETE https://services.leadconnectorhq.com/invoices/{invoiceId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Invoice Id
## Query parameters
account Id / company Id based on altType
Alt Type
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
"invoiceItems": [
// truncado: 20 lineas mas
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Unable to find an invoice with the given invoice id"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete schedule
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-delete-invoice-schedule
API to delete an schedule by schedule id
API to delete an schedule by schedule id
```http theme={null}
DELETE https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Schedule Id
## Query parameters
account Id / company Id based on altType
Alt Type
## Respuestas
success
```json theme={null}
{
"success": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-delete-invoice-template
API to update an template by template id
API to update an template by template id
```http theme={null}
DELETE https://services.leadconnectorhq.com/invoices/template/{templateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Template Id
## Query parameters
account Id / company Id based on altType
Alt Type
## Respuestas
success
```json theme={null}
{
"success": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/template/YOUR_templateId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Generate Estimate Number
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-generate-estimate-number
Get the next estimate number for the given account
Get the next estimate number for the given account
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/estimate/number/generate
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id or Agency Id
## Respuestas
```json theme={null}
{
"estimateNumber": 0,
"traceId": "string"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/estimate/number/generate' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/number/generate', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/estimate/number/generate',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Generate Invoice Number
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-generate-invoice-number
Get the next invoice number for the given account
Get the next invoice number for the given account
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/generate-invoice-number
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id
## Respuestas
Invoice Number
```json theme={null}
{
"invoiceNumber": "19"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/generate-invoice-number' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/generate-invoice-number', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/generate-invoice-number',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-get-invoice
API to get invoice by invoice id
API to get invoice by invoice id
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/{invoiceId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Invoice Id
## Query parameters
account Id / company Id based on altType
Alt Type
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
subTotal
discount
tax
Reminders Configuration
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
"invoiceItems": [
// truncado: 25 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get an schedule
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-get-invoice-schedule
API to get an schedule by schedule id
API to get an schedule by schedule id
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Schedule Id
## Query parameters
account Id / company Id based on altType
Alt Type
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Invoice Settings
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-get-invoice-settings
Get the invoice settings for the given account
Get the invoice settings for the given account
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/settings
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id or Agency Id
## Respuestas
Account Id
Alt Type Posibles valores: 'account'
Terms and conditions for invoices
Terms and conditions for estimates
Title for invoices
Title for estimates
Prefix for invoice numbers
Prefix for estimate numbers
Number of days after which invoice is due
Number of days after which estimate expires
Minimum percentage for partial payment
Custom fields array
Custom notification settings
Business details
Sender configuration
Product settings
Reminder settings
Late fees configuration
Tips configuration
Payment methods configuration
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"termsNote": "Payment is due within 30 days.",
"estimatesTermsNote": "This estimate is valid for 30 days.",
"title": "INVOICE",
"estimatesTitle": "ESTIMATE",
"invoiceNumberPrefix": "INV-",
"estimateNumberPrefix": "EST-",
"dueAfterXDays": 30,
"estimatesExpireAfterXDays": 30,
"minimumPercentagePartialPayment": 25,
"customFields": [
"6578278e879ad2646715baxc",
"6901e9fb77ac4d701ba0b996"
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/settings' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/settings', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/settings',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get an template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-get-invoice-template
API to get an template by template id
API to get an template by template id
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/template/{templateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Template Id
## Query parameters
account Id / company Id based on altType
Alt Type
## Respuestas
Template Id
Account Id or Agency Id
Posibles valores: 'account'
Name of the Template
Business Details
Currency
Discount
Invoice Items
prefix for invoice number
Total Amount
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Template",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"currency": "USD",
"discount": {
"type": "percentage",
"value": 0
},
"items": [
{
"taxes": [],
"_id": "c6tZZU0rJBf30ZXx9Gli",
"productId": "c6tZZU0rJBf30ZXx9Gli",
"priceId": "c6tZZU0rJBf30ZXx9Gli",
"currency": "USD",
"name": "Macbook Pro",
"qty": 1,
"amount": 999
}
],
"invoiceNumberPrefix": "INV-",
"total": 999,
"createdAt": "2023-12-12T09:27:42.355Z",
"updatedAt": "2023-12-12T09:27:42.355Z"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/template/YOUR_templateId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Estimate Templates
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-list-estimate-templates
Get a list of estimate templates or a specific template by ID
Get a list of estimate templates or a specific template by ID
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/estimate/template
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id or Agency Id
To search for an estimate template by id / name
Limit the number of items to return
Number of items to skip
## Respuestas
List of estimate templates
Total number of estimate templates available
Unique identifier for tracing the request
```json theme={null}
{
"data": [
"string"
],
"totalCount": 0,
"traceId": "string"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/estimate/template' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/template', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/estimate/template',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Estimates
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-list-estimates
Get a paginated list of estimates
Get a paginated list of estimates
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/estimate/list
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id or Agency Id
startAt in YYYY-MM-DD format
endAt in YYYY-MM-DD format
search text for estimates name
estimate status
Contact ID for the estimate
Limit the number of items to return
Number of items to skip
## Respuestas
List of estimates
Total number of estimates
Unique identifier for tracing the request
```json theme={null}
{
"estimates": [
"string"
],
"total": 0,
"traceId": "string"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/estimate/list' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/list', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/estimate/list',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List schedules
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-list-invoice-schedules
API to get list of schedules
API to get list of schedules
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/schedule
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
account Id / company Id based on altType
Alt Type
status to be filtered
startAt in YYYY-MM-DD format
endAt in YYYY-MM-DD format
To search for an invoice by id / name / email / phoneNo
payment mode
Limit the number of items to return
Number of items to skip
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
Total number of Schedules
```json theme={null}
{
"schedules": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {}
},
"invoices": [
{}
],
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
// truncado: 26 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/schedule' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/schedule',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List templates
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-list-invoice-templates
API to get list of templates
API to get list of templates
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/template
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
account Id / company Id based on altType
Alt Type
status to be filtered
startAt in YYYY-MM-DD format
endAt in YYYY-MM-DD format
To search for an invoice by id / name / email / phoneNo
payment mode
Limit the number of items to return
Number of items to skip
## Respuestas
Template Id
Account Id or Agency Id
Posibles valores: 'account'
Name of the Template
Business Details
Currency
Discount
Invoice Items
prefix for invoice number
Total Amount
created at
updated at
Total number of Templates
```json theme={null}
{
"data": [
{
"_id": "6578278e879ad2646715ba9c",
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Template",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"currency": "USD",
"discount": {
"type": "percentage",
"value": 0
},
"items": [
{
"taxes": [],
"_id": "c6tZZU0rJBf30ZXx9Gli",
"productId": "c6tZZU0rJBf30ZXx9Gli",
"priceId": "c6tZZU0rJBf30ZXx9Gli",
"currency": "USD",
"name": "Macbook Pro",
"qty": 1,
"amount": 999
}
],
"invoiceNumberPrefix": "INV-",
"total": 999,
"createdAt": "2023-12-12T09:27:42.355Z",
// truncado: 5 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/template' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/template', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/template',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List invoices
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-list-invoices
API to get list of invoices
API to get list of invoices
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
account Id / company Id based on altType
Alt Type
status to be filtered
startAt in YYYY-MM-DD format
endAt in YYYY-MM-DD format
To search for an invoice by id / name / email / phoneNo
payment mode
Contact ID for the invoice
Limit the number of items to return
Number of items to skip
The field on which sorting should be applied
The order of sort which should be applied for the sortField
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
subTotal
discount
tax
Reminders Configuration
Total number of invoices
```json theme={null}
{
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
// truncado: 30 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Preview Estimate Template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-preview-estimate-template
Get a preview of an estimate template
Get a preview of an estimate template
```http theme={null}
GET https://services.leadconnectorhq.com/invoices/estimate/template/preview
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id or Agency Id
Template Id
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 48 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/invoices/estimate/template/preview' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/template/preview', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/invoices/estimate/template/preview',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Record a manual payment for an invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-record-invoice
API to record manual payment for an invoice by invoice id
API to record manual payment for an invoice by invoice id
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/{invoiceId}/record-payment
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Invoice Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
manual payment method Posibles valores: 'cash', 'card', 'cheque', 'bank\_transfer', 'other'
check number
Any note to be recorded with the transaction
Amount to be paid against the invoice.
Payment Schedule Ids to be recorded against the invoice.
Updated At to be recorded against the invoice.
## Respuestas
status
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
```json theme={null}
{
"success": true,
"invoice": {
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
// truncado: 23 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/record-payment' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"mode": "card",
"card": {
"brand": "string",
"last4": "string"
},
"cheque": {
"number": "129-129-129-912"
},
"notes": "This was a direct payment",
"amount": 999,
"meta": {},
"paymentScheduleIds": [
"6578278e879ad2646715ba9c"
],
"fulfilledAt": "2025-03-19T05:03:00.000Z"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/record-payment', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "mode": "card", "card": {"brand": "string", "last4": "string"}, "cheque": {"number": "129-129-129-912"}, "notes": "This was a direct payment", "amount": 999, "meta": {}, "paymentScheduleIds": ["6578278e879ad2646715ba9c"], "fulfilledAt": "2025-03-19T05:03:00.000Z"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/record-payment',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "mode": "card", "card": {"brand": "string", "last4": "string"}, "cheque": {"number": "129-129-129-912"}, "notes": "This was a direct payment", "amount": 999, "meta": {}, "paymentScheduleIds": ["6578278e879ad2646715ba9c"], "fulfilledAt": "2025-03-19T05:03:00.000Z"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'mode': 'card', 'card': {'brand': 'string', 'last4': 'string'}, 'cheque': {'number': '129-129-129-912'}, 'notes': 'This was a direct payment', 'amount': 999, 'meta': {}, 'paymentScheduleIds': ['6578278e879ad2646715ba9c'], 'fulfilledAt': '2025-03-19T05:03:00.000Z'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Schedule an schedule invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-schedule-invoice-schedule
API to schedule an schedule invoice to start sending to the customer
API to schedule an schedule invoice to start sending to the customer
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}/schedule
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Schedule Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
auto-payment configuration
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/schedule' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"liveMode": true
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/schedule', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "liveMode": true}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/schedule',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "liveMode": true},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'liveMode': true}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Send Estimate
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-send-estimate
API to send estimate by estimate id
API to send estimate by estimate id
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/estimate/{estimateId}/send
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Estimate Id
## Body
Account Id or Agency Id
Posibles valores: 'account'
Posibles valores: 'sms\_and\_email', 'send\_manually', 'email', 'sms'
livemode for estimate
Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this account. This account will serve as the primary channel for all future communications and updates.
sender details for invoice, valid only if invoice is not sent manually
estimate name
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
Company identifier associated with the estimate
Contact details for the estimate
Date when the estimate was issued
Date when the estimate expires
User who sent the estimate
Indicates if automatic taxes were calculated
Additional metadata associated with the estimate
History of actions taken on the estimate
Recipient details for the estimate
Frequency settings for recurring estimates
Timestamp when the estimate was last visited
Total amount in USD
Auto-invoice settings for the estimate
Trace ID for logging and debugging
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 86 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"action": "sms_and_email",
"liveMode": true,
"userId": "6578278e879ad2646715ba9c",
"estimateName": "Estimate"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "action": "sms_and_email", "liveMode": true, "userId": "6578278e879ad2646715ba9c", "estimateName": "Estimate"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "action": "sms_and_email", "liveMode": true, "userId": "6578278e879ad2646715ba9c", "estimateName": "Estimate"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'action': 'sms_and_email', 'liveMode': true, 'userId': '6578278e879ad2646715ba9c', 'estimateName': 'Estimate'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Send invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-send-invoice
API to send invoice by invoice id
API to send invoice by invoice id
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/{invoiceId}/send
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Invoice Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this account. This account will serve as the primary channel for all future communications and updates.
Posibles valores: 'sms\_and\_email', 'send\_manually', 'email', 'sms'
sender details for invoice, valid only if invoice is not sent manually
auto-payment configuration
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
```json theme={null}
{
"invoice": {
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
// truncado: 24 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/send' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"userId": "6578278e879ad2646715ba9c",
"action": "sms_and_email",
"liveMode": true
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/send', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "userId": "6578278e879ad2646715ba9c", "action": "sms_and_email", "liveMode": true}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/send',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "userId": "6578278e879ad2646715ba9c", "action": "sms_and_email", "liveMode": true},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'userId': '6578278e879ad2646715ba9c', 'action': 'sms_and_email', 'liveMode': true}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create & Send
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-text2pay-invoice
API to create or update a text2pay invoice
API to create or update a text2pay invoice
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/text2pay
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Invoice Name
Currency code
An array of items for the invoice.
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Terms notes, Also supports HTML markups
Title for the invoice
Contact information to send the invoice to
Invoice Number
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Email Address
cc to be kept in any sent out emails
bcc to be kept in any sent out emails
Contact Phone Number
Automatic taxes enabled for the Invoice
split invoice into payment schedule summing up to full invoice amount
late fees configuration
tips configuration for the invoice
prefix for invoice number
Payment Methods for Invoices
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
miscellaneous charges for the invoice
id of invoice to update. If skipped, a new invoice will be created
include terms & notes with receipts
create invoice in draft mode or send mode Posibles valores: 'draft', 'send'
id of user generating invoice
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
preview url of generated invoice
```json theme={null}
{
"invoice": {
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
// truncado: 23 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/text2pay' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"currency": "USD",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true
}
],
"termsNotes": "This is a default terms.
",
"title": "INVOICE",
"invoiceNumber": "1001",
"issueDate": "2023-01-01",
"dueDate": "2023-01-14",
"sentTo": {
"email": [
"alex@example.com"
],
"emailCc": [
"alex@example.com"
],
"emailBcc": [
"alex@example.com"
],
"phoneNo": [
"+1-214-559-6993"
]
},
"liveMode": true,
"automaticTaxesEnabled": true,
"invoiceNumberPrefix": "INV-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
],
"id": "string",
"includeTermsNote": true,
"action": "draft",
"userId": "string",
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
}
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/text2pay', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "New Invoice", "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "termsNotes": "This is a default terms.
", "title": "INVOICE", "invoiceNumber": "1001", "issueDate": "2023-01-01", "dueDate": "2023-01-14", "sentTo": {"email": ["alex@example.com"], "emailCc": ["alex@example.com"], "emailBcc": ["alex@example.com"], "phoneNo": ["+1-214-559-6993"]}, "liveMode": true, "automaticTaxesEnabled": true, "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}], "id": "string", "includeTermsNote": true, "action": "draft", "userId": "string", "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/text2pay',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "New Invoice", "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "termsNotes": "This is a default terms.
", "title": "INVOICE", "invoiceNumber": "1001", "issueDate": "2023-01-01", "dueDate": "2023-01-14", "sentTo": {"email": ["alex@example.com"], "emailCc": ["alex@example.com"], "emailBcc": ["alex@example.com"], "phoneNo": ["+1-214-559-6993"]}, "liveMode": true, "automaticTaxesEnabled": true, "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}], "id": "string", "includeTermsNote": true, "action": "draft", "userId": "string", "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'New Invoice', 'currency': 'USD', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'termsNotes': 'This is a default terms.
', 'title': 'INVOICE', 'invoiceNumber': '1001', 'issueDate': '2023-01-01', 'dueDate': '2023-01-14', 'sentTo': {'email': ['alex@example.com'], 'emailCc': ['alex@example.com'], 'emailBcc': ['alex@example.com'], 'phoneNo': ['+1-214-559-6993']}, 'liveMode': true, 'automaticTaxesEnabled': true, 'invoiceNumberPrefix': 'INV-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}], 'id': 'string', 'includeTermsNote': true, 'action': 'draft', 'userId': 'string', 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update scheduled recurring invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-and-schedule-invoice-schedule
API to update scheduled recurring invoice
API to update scheduled recurring invoice
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}/updateAndSchedule
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Schedule Id
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/updateAndSchedule' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/updateAndSchedule', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/updateAndSchedule',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Estimate
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-estimate
Update an existing estimate with new details
Update an existing estimate with new details
```http theme={null}
PUT https://services.leadconnectorhq.com/invoices/estimate/{estimateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Estimate Id
## Body
Account Id or Agency Id
Posibles valores: 'account'
Estimate Name
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Currency code
An array of items for the estimate.
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Attachments for the line item
livemode for estimate
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Terms notes, Also supports HTML markups
Title for the estimate
Contact information to send the estimate to
Estimate Number, if not specified will take in the next valid estimate number
issue date estimate
expiry date estimate
Email and sent to details for the estimate
Automatic taxes enabled for the Estimate
Meta data for the estimate
When sending estimate directly while saving
frequency settings for the estimate
Prefix for the estimate number
User Id
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
Auto invoice for the estimate
miscellaneous charges for the estimate
Payment Schedule Config for the estimate
Estimate Status Posibles valores: 'all', 'draft', 'sent', 'accepted', 'declined', 'invoiced', 'viewed'
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
Company identifier associated with the estimate
Contact details for the estimate
Date when the estimate was issued
Date when the estimate expires
User who sent the estimate
Indicates if automatic taxes were calculated
Additional metadata associated with the estimate
History of actions taken on the estimate
Recipient details for the estimate
Frequency settings for recurring estimates
Timestamp when the estimate was last visited
Total amount in USD
Auto-invoice settings for the estimate
Trace ID for logging and debugging
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 86 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "Home Service Estimate",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "USD",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true,
"attachments": [
"https://example.com/file1.jpg",
"https://example.com/file2.png"
]
}
],
"liveMode": true,
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "This is a default terms.
",
"title": "ESTIMATE",
"estimateNumber": 1001,
"issueDate": "2024-08-07",
"expiryDate": "2024-08-10",
"automaticTaxesEnabled": true,
"meta": {
"key": "value"
},
"estimateNumberPrefix": "EST-",
"userId": "6578278e879ad2646715ba9c",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
],
"autoInvoice": {
"enabled": true,
"directPayments": true
},
"estimateStatus": "sent"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true, "attachments": ["https://example.com/file1.jpg", "https://example.com/file2.png"]}], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "estimateNumber": 1001, "issueDate": "2024-08-07", "expiryDate": "2024-08-10", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "userId": "6578278e879ad2646715ba9c", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}], "autoInvoice": {"enabled": true, "directPayments": true}, "estimateStatus": "sent"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true, "attachments": ["https://example.com/file1.jpg", "https://example.com/file2.png"]}], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "estimateNumber": 1001, "issueDate": "2024-08-07", "expiryDate": "2024-08-10", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "userId": "6578278e879ad2646715ba9c", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}], "autoInvoice": {"enabled": true, "directPayments": true}, "estimateStatus": "sent"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'Home Service Estimate', 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'USD', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true, 'attachments': ['https://example.com/file1.jpg', 'https://example.com/file2.png']}], 'liveMode': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'This is a default terms.
', 'title': 'ESTIMATE', 'estimateNumber': 1001, 'issueDate': '2024-08-07', 'expiryDate': '2024-08-10', 'automaticTaxesEnabled': true, 'meta': {'key': 'value'}, 'estimateNumberPrefix': 'EST-', 'userId': '6578278e879ad2646715ba9c', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}], 'autoInvoice': {'enabled': true, 'directPayments': true}, 'estimateStatus': 'sent'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update estimate last visited at
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-estimate-last-visited-at
API to update estimate last visited at by estimate id
API to update estimate last visited at by estimate id
```http theme={null}
PATCH https://services.leadconnectorhq.com/invoices/estimate/stats/last-visited-at
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Estimate Id
## Respuestas
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PATCH 'https://services.leadconnectorhq.com/invoices/estimate/stats/last-visited-at' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"estimateId": "5f9d6d8b1b2d2c001f2d9e4b"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/stats/last-visited-at', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"estimateId": "5f9d6d8b1b2d2c001f2d9e4b"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/invoices/estimate/stats/last-visited-at',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"estimateId": "5f9d6d8b1b2d2c001f2d9e4b"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'estimateId': '5f9d6d8b1b2d2c001f2d9e4b'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Estimate Template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-estimate-template
Update an existing estimate template
Update an existing estimate template
```http theme={null}
PUT https://services.leadconnectorhq.com/invoices/estimate/template/{templateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Template Id
## Body
Account Id or Agency Id
Posibles valores: 'account'
Estimate Name
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Currency code
An array of items for the estimate.
livemode for estimate
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Terms notes, Also supports HTML markups
Title for the estimate
Automatic taxes enabled for the Estimate
Meta data for the estimate
When sending estimate directly while saving
Prefix for the estimate number
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
miscellaneous charges for the estimate
## Respuestas
Account Id or Agency Id
Posibles valores: 'account'
Unique identifier
Indicates if it is in live mode
Indicates if deleted
Name
Currency code
Business details associated with the estimate
An array of items
Discount details for the estimate template
Title
Estimate number prefix
Attachments
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
User Id of who last updated
Total amount
Timestamp when created
Timestamp when last updated
Version number
Indicates if automatic taxes are enabled for this estimate
Terms and conditions for the estimate, supports HTML markup
```json theme={null}
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"logoUrl": "your_image-url",
"name": "Business name",
"address": {
"addressLine1": "address line 1",
"city": "Test City",
"state": "State Name",
"countryCode": "US",
"postalCode": "12345"
},
"phoneNo": "+1 1234567890",
"website": "www.example.com",
"customValues": [
{
"name": "Test",
"fieldKey": "{{custom_values.test}}",
"id": "5DYTWoiQvWiIJZXX44XXX",
"value": "Test's Custom Value"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "Futuristic anti-gravity racing
",
"currency": "USD",
"productId": "67ac9a51106ee8311e911XXXX",
"priceId": "67ac9a51106ee8311e911XXXX",
"amount": 9.99,
// truncado: 48 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/invoices/estimate/template/YOUR_templateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "Home Service Estimate Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "USD",
"items": [
[]
],
"liveMode": true,
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "This is a default terms.
",
"title": "ESTIMATE",
"automaticTaxesEnabled": true,
"meta": {
"key": "value"
},
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/template/YOUR_templateId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [[]], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/invoices/estimate/template/YOUR_templateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "Home Service Estimate Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "USD", "items": [[]], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "This is a default terms.
", "title": "ESTIMATE", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'Home Service Estimate Template', 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'USD', 'items': [[]], 'liveMode': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'This is a default terms.
', 'title': 'ESTIMATE', 'automaticTaxesEnabled': true, 'meta': {'key': 'value'}, 'estimateNumberPrefix': 'EST-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-invoice
API to update invoice by invoice id
API to update invoice by invoice id
```http theme={null}
PUT https://services.leadconnectorhq.com/invoices/{invoiceId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Invoice Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Name to be updated
Title for the invoice
Currency
Description
Business details which need to be updated
Invoice Number
Id of the contact which you need to send the invoice
Contact ID
Contact Name
Contact Phone Number
Contact Email
Secondary email addresses for the contact to be saved
Contact Company Name
Address Line 1
Address Line 2
City
State
Country Code
Postal Code
Custom Values
Terms notes, Also supports HTML markups
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Automatic taxes enabled for the Invoice
Payment mode
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
split invoice into payment schedule summing up to full invoice amount
tips configuration for the invoice
prefix for invoice number
Payment Methods for Invoices
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
miscellaneous charges for the invoice
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
"invoiceItems": [
// truncado: 20 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"title": "INVOICE",
"currency": "USD",
"description": "ABC Corp payments",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "1001",
"contactId": "6578278e879ad2646715ba9c",
"contactDetails": {
"id": "6578278e879ad2646715ba9c",
"name": "Alex",
"phoneNo": "+1234567890",
"email": "alex@example.com",
"additionalEmails": [
{
"email": "alex@example.com"
}
],
"companyName": "ABC Corp.",
"address": {
"addressLine1": "9931 Beechwood",
"addressLine2": "Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "US",
"postalCode": "559-6993"
},
"customFields": [
"string"
]
},
"termsNotes": "This is a default terms.
",
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"invoiceItems": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true
}
],
"automaticTaxesEnabled": true,
"liveMode": true,
"issueDate": "2023-01-01",
"dueDate": "2023-01-14",
"xeroDetails": {},
"invoiceNumberPrefix": "INV-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "New Invoice", "title": "INVOICE", "currency": "USD", "description": "ABC Corp payments", "businessDetails": {"name": "Alex", "address": {"addressLine1": "9931 Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "USA", "postalCode": "559-6993"}, "phoneNo": "+1-214-559-6993", "website": "www.example.com"}, "invoiceNumber": "1001", "contactId": "6578278e879ad2646715ba9c", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "termsNotes": "This is a default terms.
", "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "invoiceItems": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "liveMode": true, "issueDate": "2023-01-01", "dueDate": "2023-01-14", "xeroDetails": {}, "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "New Invoice", "title": "INVOICE", "currency": "USD", "description": "ABC Corp payments", "businessDetails": {"name": "Alex", "address": {"addressLine1": "9931 Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "USA", "postalCode": "559-6993"}, "phoneNo": "+1-214-559-6993", "website": "www.example.com"}, "invoiceNumber": "1001", "contactId": "6578278e879ad2646715ba9c", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "termsNotes": "This is a default terms.
", "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "invoiceItems": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "liveMode": true, "issueDate": "2023-01-01", "dueDate": "2023-01-14", "xeroDetails": {}, "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'New Invoice', 'title': 'INVOICE', 'currency': 'USD', 'description': 'ABC Corp payments', 'businessDetails': {'name': 'Alex', 'address': {'addressLine1': '9931 Beechwood', 'city': 'St. Houston', 'state': 'TX', 'countryCode': 'USA', 'postalCode': '559-6993'}, 'phoneNo': '+1-214-559-6993', 'website': 'www.example.com'}, 'invoiceNumber': '1001', 'contactId': '6578278e879ad2646715ba9c', 'contactDetails': {'id': '6578278e879ad2646715ba9c', 'name': 'Alex', 'phoneNo': '+1234567890', 'email': 'alex@example.com', 'additionalEmails': [{'email': 'alex@example.com'}], 'companyName': 'ABC Corp.', 'address': {'addressLine1': '9931 Beechwood', 'addressLine2': 'Beechwood', 'city': 'St. Houston', 'state': 'TX', 'countryCode': 'US', 'postalCode': '559-6993'}, 'customFields': ['string']}, 'termsNotes': 'This is a default terms.
', 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'invoiceItems': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'automaticTaxesEnabled': true, 'liveMode': true, 'issueDate': '2023-01-01', 'dueDate': '2023-01-14', 'xeroDetails': {}, 'invoiceNumberPrefix': 'INV-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update invoice last visited at
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-invoice-last-visited-at
API to update invoice last visited at by invoice id
API to update invoice last visited at by invoice id
```http theme={null}
PATCH https://services.leadconnectorhq.com/invoices/stats/last-visited-at
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Invoice Id
## Respuestas
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PATCH 'https://services.leadconnectorhq.com/invoices/stats/last-visited-at' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"invoiceId": "6578278e879ad2646715ba9c"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/stats/last-visited-at', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"invoiceId": "6578278e879ad2646715ba9c"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/invoices/stats/last-visited-at',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"invoiceId": "6578278e879ad2646715ba9c"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'invoiceId': '6578278e879ad2646715ba9c'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update invoice late fees configuration
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-invoice-late-fees-configuration
API to update invoice late fees configuration by invoice id
API to update invoice late fees configuration by invoice id
```http theme={null}
PATCH https://services.leadconnectorhq.com/invoices/{invoiceId}/late-fees-configuration
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Invoice Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
late fees configuration
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
"invoiceItems": [
// truncado: 20 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PATCH 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/late-fees-configuration' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/late-fees-configuration', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/late-fees-configuration',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update template late fees configuration
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-invoice-payment-methods-configuration
API to update template late fees configuration by template id
API to update template late fees configuration by template id
```http theme={null}
PATCH https://services.leadconnectorhq.com/invoices/template/{templateId}/payment-methods-configuration
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Template Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Payment Methods for Invoices
## Respuestas
Template Id
Account Id or Agency Id
Posibles valores: 'account'
Name of the Template
Business Details
Currency
Discount
Invoice Items
prefix for invoice number
Total Amount
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Template",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"currency": "USD",
"discount": {
"type": "percentage",
"value": 0
},
"items": [
{
"taxes": [],
"_id": "c6tZZU0rJBf30ZXx9Gli",
"productId": "c6tZZU0rJBf30ZXx9Gli",
"priceId": "c6tZZU0rJBf30ZXx9Gli",
"currency": "USD",
"name": "Macbook Pro",
"qty": 1,
"amount": 999
}
],
"invoiceNumberPrefix": "INV-",
"total": 999,
"createdAt": "2023-12-12T09:27:42.355Z",
"updatedAt": "2023-12-12T09:27:42.355Z"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PATCH 'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId/payment-methods-configuration' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/template/YOUR_templateId/payment-methods-configuration', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId/payment-methods-configuration',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update schedule
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-invoice-schedule
API to update an schedule by schedule id
API to update an schedule by schedule id
```http theme={null}
PUT https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Schedule Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Contact ID
Contact Name
Contact Phone Number
Contact Email
Secondary email addresses for the contact to be saved
Contact Company Name
Address Line 1
Address Line 2
City
State
Country Code
Postal Code
Custom Values
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
attachments for the invoice
Id of the file selected
Name of the file
URL of the file
Type of the file
Size of the file
miscellaneous charges for the invoice
## Respuestas
Schedule Id
Schedule Status
Live Mode
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Posibles valores: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
End date in YYYY-MM-DD format
End time in HH:mm:ss format
-1, 1, 2, 3, ..., 27, 28
Posibles valores: 'mo', 'tu', 'we', 'th', 'fr', 'sa', 'su'
-1, 1, 2, 3, 4
Posibles valores: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'
Max number of task executions
Execute task number of days before
Start as primary user accepted date
End type like after, by, count
List of invoices
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
Business Details
Currency
Contact Details
Discount
Invoice Items
Total Amount
Title
Terms notes
Compiled terms notes
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "string",
"contactDetails": {
"id": "6578278e879ad2646715ba9c",
"name": "Alex",
"phoneNo": "+1234567890",
"email": "alex@example.com",
"additionalEmails": [
{
"email": "alex@example.com"
}
],
"companyName": "ABC Corp.",
"address": {
"addressLine1": "9931 Beechwood",
"addressLine2": "Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "US",
"postalCode": "559-6993"
},
"customFields": [
"string"
]
},
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"liveMode": true,
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "string",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true
}
],
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "string",
"title": "string",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "string",
"size": 10000
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "string", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "schedule": {"executeAt": "string", "rrule": {"intervalType": "monthly", "interval": 2, "startDate": "2023-01-01", "startTime": "20:45:00", "endDate": "2029-11-01", "endTime": "18:45:00", "dayOfMonth": 15, "dayOfWeek": "mo", "numOfWeek": -1, "monthOfYear": "jan", "count": 10, "daysBefore": 5, "useStartAsPrimaryUserAccepted": true, "endType": "by"}}, "liveMode": true, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "string", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "string", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "schedule": {"executeAt": "string", "rrule": {"intervalType": "monthly", "interval": 2, "startDate": "2023-01-01", "startTime": "20:45:00", "endDate": "2029-11-01", "endTime": "18:45:00", "dayOfMonth": 15, "dayOfWeek": "mo", "numOfWeek": -1, "monthOfYear": "jan", "count": 10, "daysBefore": 5, "useStartAsPrimaryUserAccepted": true, "endType": "by"}}, "liveMode": true, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "string", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'string', 'contactDetails': {'id': '6578278e879ad2646715ba9c', 'name': 'Alex', 'phoneNo': '+1234567890', 'email': 'alex@example.com', 'additionalEmails': [{'email': 'alex@example.com'}], 'companyName': 'ABC Corp.', 'address': {'addressLine1': '9931 Beechwood', 'addressLine2': 'Beechwood', 'city': 'St. Houston', 'state': 'TX', 'countryCode': 'US', 'postalCode': '559-6993'}, 'customFields': ['string']}, 'schedule': {'executeAt': 'string', 'rrule': {'intervalType': 'monthly', 'interval': 2, 'startDate': '2023-01-01', 'startTime': '20:45:00', 'endDate': '2029-11-01', 'endTime': '18:45:00', 'dayOfMonth': 15, 'dayOfWeek': 'mo', 'numOfWeek': -1, 'monthOfYear': 'jan', 'count': 10, 'daysBefore': 5, 'useStartAsPrimaryUserAccepted': true, 'endType': 'by'}}, 'liveMode': true, 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'string', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'string', 'title': 'string', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update template
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-invoice-template
API to update an template by template id
API to update an template by template id
```http theme={null}
PUT https://services.leadconnectorhq.com/invoices/template/{templateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Template Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
Name of the template
Business Logo URL
Business Name
Business Phone Number
Business Address
Business Website Link
Custom Values
Invoice Item Name
Invoice descriptions
Product Id
Price Id
Currency
Product amount
Product Quantity
Tax
Posibles valores: 'exclusive'
Tax category id for calculating automatic tax
Setupfee item, only created when 1st invoice of recurring schedule is generated
Price type of the item Posibles valores: 'one\_time', 'recurring'
true if item amount is tax inclusive
Discount Value
Discount type Posibles valores: 'percentage', 'fixed'
Product Ids on which discount is applicable
Template title
miscellaneous charges for the invoice
## Respuestas
Template Id
Account Id or Agency Id
Posibles valores: 'account'
Name of the Template
Business Details
Currency
Discount
Invoice Items
prefix for invoice number
Total Amount
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Template",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"currency": "USD",
"discount": {
"type": "percentage",
"value": 0
},
"items": [
{
"taxes": [],
"_id": "c6tZZU0rJBf30ZXx9Gli",
"productId": "c6tZZU0rJBf30ZXx9Gli",
"priceId": "c6tZZU0rJBf30ZXx9Gli",
"currency": "USD",
"name": "Macbook Pro",
"qty": 1,
"amount": 999
}
],
"invoiceNumberPrefix": "INV-",
"total": 999,
"createdAt": "2023-12-12T09:27:42.355Z",
"updatedAt": "2023-12-12T09:27:42.355Z"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"internal": true,
"name": "New Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"string"
]
},
"currency": "string",
"items": [
{
"name": "ABC Product",
"description": "ABC Corp.",
"productId": "6578278e879ad2646715ba9c",
"priceId": "6578278e879ad2646715ba9c",
"currency": "USD",
"amount": 999,
"qty": 1,
"taxes": [
{}
],
"automaticTaxCategoryId": "6578278e879ad2646715ba9c",
"isSetupFeeItem": true,
"type": "one_time",
"taxInclusive": true
}
],
"discount": {
"value": 10,
"type": "percentage",
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"termsNotes": "string",
"title": "New Template"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/template/YOUR_templateId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "internal": true, "name": "New Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "New Template"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "internal": true, "name": "New Template", "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "New Template"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'internal': true, 'name': 'New Template', 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'string', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'string', 'title': 'New Template'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update template late fees configuration
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-update-invoice-template-late-fees-configuration
API to update template late fees configuration by template id
API to update template late fees configuration by template id
```http theme={null}
PATCH https://services.leadconnectorhq.com/invoices/template/{templateId}/late-fees-configuration
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Template Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
late fees configuration
## Respuestas
Template Id
Account Id or Agency Id
Posibles valores: 'account'
Name of the Template
Business Details
Currency
Discount
Invoice Items
prefix for invoice number
Total Amount
created at
updated at
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Template",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"currency": "USD",
"discount": {
"type": "percentage",
"value": 0
},
"items": [
{
"taxes": [],
"_id": "c6tZZU0rJBf30ZXx9Gli",
"productId": "c6tZZU0rJBf30ZXx9Gli",
"priceId": "c6tZZU0rJBf30ZXx9Gli",
"currency": "USD",
"name": "Macbook Pro",
"qty": 1,
"amount": 999
}
],
"invoiceNumberPrefix": "INV-",
"total": 999,
"createdAt": "2023-12-12T09:27:42.355Z",
"updatedAt": "2023-12-12T09:27:42.355Z"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PATCH 'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId/late-fees-configuration' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/template/YOUR_templateId/late-fees-configuration', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/invoices/template/YOUR_templateId/late-fees-configuration',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Void invoice
Source: https://developers.leadwaycrm.com/api-reference/invoice/invoice-void-invoice
API to delete invoice by invoice id
API to delete invoice by invoice id
```http theme={null}
POST https://services.leadconnectorhq.com/invoices/{invoiceId}/void
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Invoice Id
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
## Respuestas
Invoice Id
Invoice Status Posibles valores: 'draft', 'sent', 'payment\_processing', 'paid', 'void', 'partially\_paid'
Live Mode
Amount Paid
Account Id or Agency Id
Posibles valores: 'account'
Name of the invoice
Business Details
Invoice Number
Currency
Contact Details
Issue date in YYYY-MM-DD format
Due date in YYYY-MM-DD format
Discount
Invoice Items
Total Amount
Title
Total Amount Due
created at
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
```json theme={null}
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
"city": "St. Houston",
"state": "TX",
"countryCode": "USA",
"postalCode": "559-6993"
},
"phoneNo": "+1-214-559-6993",
"website": "www.example.com"
},
"invoiceNumber": "19",
"currency": "USD",
"contactDetails": {
"id": "c6tZZU0rJBf30ZXx9Gli",
"phoneNo": "+1-214-559-6993",
"email": "alex@example.com",
"customFields": [],
"name": "Alex",
"address": {
"countryCode": "US"
}
},
"issueDate": "2023-01-01",
"dueDate": "2023-01-01",
"discount": {
"type": "percentage",
"value": 0
},
"invoiceItems": [
// truncado: 20 lineas mas
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Unable to find an invoice with the given invoice id"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/void' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/void', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/void',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create a new FAQ inside knowledge base
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-create
```http theme={null}
POST https://services.leadconnectorhq.com/knowledge-bases/faqs
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
account ID as string
faq question as a string
faq answer as a string
knowledge base ID as string
## Respuestas
Success status of the operation
Created FAQ details
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/knowledge-bases/faqs' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "HqDZpF8GH3qvgJTmKCoL",
"question": "What is the capital of France?",
"answer": "The capital of France is Paris.",
"knowledgeBaseId": "710KoEzy793Fxubft0bc"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/faqs', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "HqDZpF8GH3qvgJTmKCoL", "question": "What is the capital of France?", "answer": "The capital of France is Paris.", "knowledgeBaseId": "710KoEzy793Fxubft0bc"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/knowledge-bases/faqs',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "HqDZpF8GH3qvgJTmKCoL", "question": "What is the capital of France?", "answer": "The capital of France is Paris.", "knowledgeBaseId": "710KoEzy793Fxubft0bc"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 'HqDZpF8GH3qvgJTmKCoL', 'question': 'What is the capital of France?', 'answer': 'The capital of France is Paris.', 'knowledgeBaseId': '710KoEzy793Fxubft0bc'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create a new knowledge base (max 15 knowledge bases per account)
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-createknowledgebase
```http theme={null}
POST https://services.leadconnectorhq.com/knowledge-bases/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
## Respuestas
Success status of the operation
Created knowledge base details
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/knowledge-bases/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"locationId": "string"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "string", "description": "string", "locationId": "string"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/knowledge-bases/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "string", "description": "string", "locationId": "string"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'string', 'description': 'string', 'locationId': 'string'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete an existing knowledge base FAQ
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-delete
```http theme={null}
DELETE https://services.leadconnectorhq.com/knowledge-bases/faqs/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
faq ID as string
## Respuestas
Success status of the delete operation
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/knowledge-bases/faqs/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/faqs/YOUR_id', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/knowledge-bases/faqs/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete a knowledge base
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-deleteknowledgebase
```http theme={null}
DELETE https://services.leadconnectorhq.com/knowledge-bases/{knowledgeBaseId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Respuestas
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/knowledge-bases/YOUR_knowledgeBaseId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/YOUR_knowledgeBaseId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/knowledge-bases/YOUR_knowledgeBaseId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete trained pages
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-deletetrainedurlsforknowledgebase
```http theme={null}
DELETE https://services.leadconnectorhq.com/knowledge-bases/crawler
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
knowledge base ID as string
account ID as string
List of trained urls ids ( fetched from the Get all trained page links by knowledge base endpoint)
## Respuestas
Indicates if the operation was successful
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/knowledge-bases/crawler' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"knowledgeBaseId": "tDtDnQdgm2LXpyiqYvZ6",
"locationId": "tDtDnQdgm2LXpyiqYvZ6",
"urlIds": "[tDtDnQdgm2LXpyiqYvZ6]"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/crawler', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"knowledgeBaseId": "tDtDnQdgm2LXpyiqYvZ6", "locationId": "tDtDnQdgm2LXpyiqYvZ6", "urlIds": "[tDtDnQdgm2LXpyiqYvZ6]"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/knowledge-bases/crawler',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"knowledgeBaseId": "tDtDnQdgm2LXpyiqYvZ6", "locationId": "tDtDnQdgm2LXpyiqYvZ6", "urlIds": "[tDtDnQdgm2LXpyiqYvZ6]"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'knowledgeBaseId': 'tDtDnQdgm2LXpyiqYvZ6', 'locationId': 'tDtDnQdgm2LXpyiqYvZ6', 'urlIds': '[tDtDnQdgm2LXpyiqYvZ6]'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Start crawling and discover pages for training
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-discoverwebsite
```http theme={null}
POST https://services.leadconnectorhq.com/knowledge-bases/crawler
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account ID as string
Website URL as string
Mode as string Posibles valores: 'Exact', 'Path', 'Domain'
knowledge base ID as string
## Respuestas
Indicates if the operation was successful
Data containing operation details
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/knowledge-bases/crawler' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "tDtDnQdgm2LXpyiqYvZ6",
"url": "https://kubernetes.io/tDtDnQdgm2LXpyiqYvZ6",
"option": "Exact",
"knowledgeBaseId": "tDtDnQdgm2LXpyiqYvZ6"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/crawler', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "tDtDnQdgm2LXpyiqYvZ6", "url": "https://kubernetes.io/tDtDnQdgm2LXpyiqYvZ6", "option": "Exact", "knowledgeBaseId": "tDtDnQdgm2LXpyiqYvZ6"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/knowledge-bases/crawler',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "tDtDnQdgm2LXpyiqYvZ6", "url": "https://kubernetes.io/tDtDnQdgm2LXpyiqYvZ6", "option": "Exact", "knowledgeBaseId": "tDtDnQdgm2LXpyiqYvZ6"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 'tDtDnQdgm2LXpyiqYvZ6', 'url': 'https://kubernetes.io/tDtDnQdgm2LXpyiqYvZ6', 'option': 'Exact', 'knowledgeBaseId': 'tDtDnQdgm2LXpyiqYvZ6'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Get all trained page links by knowledge base
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-getallwebsiteurlsdatabyknowledgebase
```http theme={null}
GET https://services.leadconnectorhq.com/knowledge-bases/crawler
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
knowledge base ID as string
account ID as string
Page number
Records per page
query to filter on url links
## Respuestas
Total count of URLs in the knowledge base
Array of crawled URLs with their details
Unique identifier for the URL
The actual URL that was crawled
Title of the webpage
Current processing status of the URL Posibles valores: 'Pending', 'Processing', 'Successful', 'Failed', 'Existing', 'Restricted', 'Cancelled', 'Aborted', 'Training'
Account ID associated with this URL
Knowledge base ID this URL belongs to
URL to the stored content file
Whether the content was edited by user
Last updated timestamp
```json theme={null}
{
"count": 64,
"urls": [
{
"id": "688c73a25275c513f5f3a7de",
"url": "https://developer.mozilla.org/en-US/blog",
"title": "MDN Blog",
"status": "Successful",
"locationId": "qIyivCmsuEOSnyoFYEej",
"knowledgeBaseId": "Arc9QRauPKkSuMJO8D0m",
"content": "https://storage.googleapis.com/crm-conversations-ai-staging/conversationAI/2025/8/1/locations/qIyivCmsuEOSnyoFYEej/688c739c88c89f21ad30f63e-4IseusbZ3vDXMT8WNw9M.txt",
"contentEditedByUser": false,
"updatedAt": "2025-08-01T07:58:29.858Z"
}
]
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/knowledge-bases/crawler' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/crawler', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/knowledge-bases/crawler',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get crawling status for the latest operation
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-getcrawlingstatusforlatestoperation
```http theme={null}
GET https://services.leadconnectorhq.com/knowledge-bases/crawler/status
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account ID as string
operation id as string
knowledge base id
## Respuestas
Indicates if the operation was successful
Detailed crawling status data
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/knowledge-bases/crawler/status' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/crawler/status', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/knowledge-bases/crawler/status',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get knowledge base by ID
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-getknowledgebasebyid
```http theme={null}
GET https://services.leadconnectorhq.com/knowledge-bases/{knowledgeBaseId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Respuestas
Success status of the operation
Knowledge base details
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/knowledge-bases/YOUR_knowledgeBaseId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/YOUR_knowledgeBaseId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/knowledge-bases/YOUR_knowledgeBaseId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get all FAQs by knowledge base with pagination support
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-list
Retrieves FAQs for a knowledge base. Supports pagination using limit and lastFaqId parameters.
Retrieves FAQs for a knowledge base. Supports pagination using limit and lastFaqId parameters.
```http theme={null}
GET https://services.leadconnectorhq.com/knowledge-bases/faqs
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
knowledge base ID as string
account ID as string
Limit the number of FAQs returned
Last FAQ ID for pagination (cursor-based)
## Respuestas
Total count of all FAQs in the knowledge base
Array of FAQ objects
FAQ ID as string
FAQ question
FAQ question in lowercase
FAQ answer
Knowledge base ID
Account ID
Trained URL ID
Whether the FAQ is deleted
Date when FAQ was created
Date when FAQ was last updated
Last FAQ ID for pagination (use as lastFaqId in next request)
Whether there are more FAQs available
```json theme={null}
{
"count": 150,
"faqs": [
{
"id": "3rzeElC1FOVY91veVBkp",
"question": "What is 1+2?",
"questionLowerCase": "what is 1+2?",
"answer": "3",
"knowledgeBaseId": "I1rITlYLJofFosIqC4Np",
"locationId": "qIyivCmsuEOSnyoFYEej",
"trainedUrlId": "688e6b6d8a1887e6d94d1475",
"deleted": false,
"createdAt": "2025-08-02T19:47:57.243Z",
"updatedAt": "2025-08-02T19:47:57.243Z"
}
],
"lastFaqId": "3rzeElC1FOVY91veVBkp",
"hasMore": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/knowledge-bases/faqs' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/faqs', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/knowledge-bases/faqs',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get all knowledge bases for a account by account Id (paginated)
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-listallknowledgebasespaginated
```http theme={null}
GET https://services.leadconnectorhq.com/knowledge-bases/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
search query for knowledge base name
Maximum number of knowledge bases to return
ID of the last knowledge base from the previous page (for pagination)
## Respuestas
Success status of the operation
Paginated knowledge bases data
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/knowledge-bases/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/knowledge-bases/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Train discovered website pages and ingest into the knowledge base
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-traindiscoveredurls
```http theme={null}
POST https://services.leadconnectorhq.com/knowledge-bases/crawler/train
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account ID as string
List of Object ids of the discovered urls
knowledge base id
operation id as string
## Respuestas
Indicates if the operation was successful
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/knowledge-bases/crawler/train' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "tDtDnQdgm2LXpyiqYvZ6",
"urlIds": [
"688b640bcb02d498102a13ec",
"688b640bcb02d498102a13ea"
],
"knowledgeBaseId": "jjkkxftgvbhjmn,",
"operationId": "688b640bcb02d498102a13f0,"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/crawler/train', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "tDtDnQdgm2LXpyiqYvZ6", "urlIds": ["688b640bcb02d498102a13ec", "688b640bcb02d498102a13ea"], "knowledgeBaseId": "jjkkxftgvbhjmn,", "operationId": "688b640bcb02d498102a13f0,"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/knowledge-bases/crawler/train',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "tDtDnQdgm2LXpyiqYvZ6", "urlIds": ["688b640bcb02d498102a13ec", "688b640bcb02d498102a13ea"], "knowledgeBaseId": "jjkkxftgvbhjmn,", "operationId": "688b640bcb02d498102a13f0,"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 'tDtDnQdgm2LXpyiqYvZ6', 'urlIds': ['688b640bcb02d498102a13ec', '688b640bcb02d498102a13ea'], 'knowledgeBaseId': 'jjkkxftgvbhjmn,', 'operationId': '688b640bcb02d498102a13f0,'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update an existing knowledge base FAQ
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-update
```http theme={null}
PUT https://services.leadconnectorhq.com/knowledge-bases/faqs/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
faq ID as string
## Body
faq question as a string
faq answer as a string
## Respuestas
Success status of the update operation
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
```json theme={null}
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}
```
```json theme={null}
{
"statusCode": 500,
"message": "Internal Server Error"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/knowledge-bases/faqs/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"question": "What is the capital of France?",
"answer": "The capital of France is Paris."
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/faqs/YOUR_id', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"question": "What is the capital of France?", "answer": "The capital of France is Paris."}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/knowledge-bases/faqs/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"question": "What is the capital of France?", "answer": "The capital of France is Paris."},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'question': 'What is the capital of France?', 'answer': 'The capital of France is Paris.'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update a knowledge base
Source: https://developers.leadwaycrm.com/api-reference/knowledge-base/knowledge-base-updateknowledgebase
```http theme={null}
PUT https://services.leadconnectorhq.com/knowledge-bases/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Body
field to update the name of the knowledge base
field to update the description of the knowledge base
## Respuestas
```json theme={null}
{
"success": true
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
```json theme={null}
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/knowledge-bases/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/knowledge-bases/YOUR_id', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "string", "description": "string"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/knowledge-bases/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "string", "description": "string"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'string', 'description': 'string'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create a new template
Source: https://developers.leadwaycrm.com/api-reference/lc-email/lc-email-create-template
Create a new template
Create a new template
```http theme={null}
POST https://services.leadconnectorhq.com/emails/builder
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Posibles valores: 'html', 'folder', 'import', 'builder', 'blank'
Posibles valores: '1', '2'
Posibles valores: 'mailchimp', 'active\_campaign', 'kajabi'
## Respuestas
template id
trace id
```json theme={null}
{
"redirect": "66e811229245fc098765590",
"traceId": "0c52e980-41f6-4be7-8c4b-e2c5a13dc3c2"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/emails/builder' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "ve9EPM428h8vShlRW1KT",
"title": "template title",
"type": "html",
"updatedBy": "zYy3YOUuHxgomU1uYJty",
"builderVersion": "2",
"name": "Template1",
"parentId": "zYy3YOUuHxgomU1uYJty",
"templateDataUrl": "",
"importProvider": "mailchimp",
"importURL": "https://tplshare.com/fhYJ3Mi",
"templateSource": "template_library",
"isPlainText": false
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/emails/builder', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "ve9EPM428h8vShlRW1KT", "title": "template title", "type": "html", "updatedBy": "zYy3YOUuHxgomU1uYJty", "builderVersion": "2", "name": "Template1", "parentId": "zYy3YOUuHxgomU1uYJty", "templateDataUrl": "", "importProvider": "mailchimp", "importURL": "https://tplshare.com/fhYJ3Mi", "templateSource": "template_library", "isPlainText": false}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/emails/builder',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "ve9EPM428h8vShlRW1KT", "title": "template title", "type": "html", "updatedBy": "zYy3YOUuHxgomU1uYJty", "builderVersion": "2", "name": "Template1", "parentId": "zYy3YOUuHxgomU1uYJty", "templateDataUrl": "", "importProvider": "mailchimp", "importURL": "https://tplshare.com/fhYJ3Mi", "templateSource": "template_library", "isPlainText": false},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 've9EPM428h8vShlRW1KT', 'title': 'template title', 'type': 'html', 'updatedBy': 'zYy3YOUuHxgomU1uYJty', 'builderVersion': '2', 'name': 'Template1', 'parentId': 'zYy3YOUuHxgomU1uYJty', 'templateDataUrl': '', 'importProvider': 'mailchimp', 'importURL': 'https://tplshare.com/fhYJ3Mi', 'templateSource': 'template_library', 'isPlainText': false}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete a template
Source: https://developers.leadwaycrm.com/api-reference/lc-email/lc-email-delete-template
Delete a template
Delete a template
```http theme={null}
DELETE https://services.leadconnectorhq.com/emails/builder/{locationId}/{templateId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Respuestas
ok
trace id
```json theme={null}
{
"ok": "true",
"traceId": "0c52e980-41f6-4be7-8c4b-32332ss"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/emails/builder/YOUR_locationId/YOUR_templateId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/emails/builder/YOUR_locationId/YOUR_templateId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/emails/builder/YOUR_locationId/YOUR_templateId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Campaigns
Source: https://developers.leadwaycrm.com/api-reference/lc-email/lc-email-fetch-campaigns
Get Campaigns
Get Campaigns
```http theme={null}
GET https://services.leadconnectorhq.com/emails/schedule
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account ID to fetch campaigns from
Maximum number of campaigns to return. Defaults to 10, maximum is 100
Number of campaigns to skip for pagination
Filter by schedule status
Filter by email delivery status
Filter campaigns by name
Filter campaigns by parent folder ID
When true, returns only essential campaign fields like id, templateDataDownloadUrl, updatedAt, type, templateType, templateId, downloadUrl and isPlainText. When false, returns complete campaign data including meta information, bulkRequestStatusInfo, ABTestInfo, resendScheduleInfo and all other campaign properties
Filter archived campaigns
Return only campaigns, excluding folders
When true, returns campaign statistics including delivered count, opened count, clicked count and revenue if available for the campaign. When false, returns campaign data without statistics.
## Respuestas
The list of campaigns
The total number of campaigns
Trace Id
```json theme={null}
{
"schedules": [
{
"name": "Untitled new campaign",
"repeatAfter": "string",
"id": "string",
"parentId": "string",
"childCount": 0,
"campaignType": "string",
"bulkActionVersion": "string",
"_id": "string",
"status": "string",
"sendDays": [
"string"
],
"deleted": true,
"migrated": true,
"archived": true,
"hasTracking": true,
"isPlainText": true,
"hasUtmTracking": true,
"enableResendToUnopened": true,
"locationId": "string",
"templateId": "string",
"templateType": "string",
"createdAt": "string",
"updatedAt": "string",
"__v": 0,
"documentId": "string",
"downloadUrl": "string",
"templateDataDownloadUrl": "string",
"child": [
"string"
]
}
],
"total": [
"string"
],
// truncado: 2 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{
"statusCode": 403,
"message": "The token does not have access to this account"
}
```
```json theme={null}
{
"statusCode": 404,
"message": "Not Found",
"error": "The requested resource was not found"
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/emails/schedule' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/emails/schedule', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/emails/schedule',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch email templates
Source: https://developers.leadwaycrm.com/api-reference/lc-email/lc-email-fetch-template
Fetch email templates by account id
Fetch email templates by account id
```http theme={null}
GET https://services.leadconnectorhq.com/emails/builder
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
## Respuestas
template name
updated by
plain text based template
last updated
date added
preview url
id
version
type
```json theme={null}
{
"name": "New Template",
"updatedBy": "John Doe",
"isPlainText": "false",
"lastUpdated": "2024-11-12T12:34:36.070Z",
"dateAdded": "2024-11-12T12:34:36.070Z",
"previewUrl": "https://example.com",
"id": "67334b231f2fad724062f52b5",
"version": "1",
"templateType": "builder"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/emails/builder' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/emails/builder', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/emails/builder',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update a template
Source: https://developers.leadwaycrm.com/api-reference/lc-email/lc-email-update-template
Update a template
Update a template
```http theme={null}
POST https://services.leadconnectorhq.com/emails/builder/data
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Posibles valores: 'html', 'builder'
## Respuestas
ok
trace id
preview url
template data download url
```json theme={null}
{
"ok": "true",
"traceId": "0c52e980-41f6-4be7-8c4b-32332ss",
"previewUrl": "https://example.com",
"templateDownloadUrl": "https://example.com"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/emails/builder/data' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "ve9EPM428h8vShlRW1KT",
"templateId": "zYy3YOUuHxgomU1uYJty",
"updatedBy": "zYy3YOUuHxgomU1uYJty",
"dnd": "{elements:[], attrs:{}, templateSettings:{}}",
"html": "",
"editorType": "html",
"previewText": "zYy3YOUuHxgomU1uYJty",
"isPlainText": "false"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/emails/builder/data', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "ve9EPM428h8vShlRW1KT", "templateId": "zYy3YOUuHxgomU1uYJty", "updatedBy": "zYy3YOUuHxgomU1uYJty", "dnd": "{elements:[], attrs:{}, templateSettings:{}}", "html": "", "editorType": "html", "previewText": "zYy3YOUuHxgomU1uYJty", "isPlainText": "false"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/emails/builder/data',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "ve9EPM428h8vShlRW1KT", "templateId": "zYy3YOUuHxgomU1uYJty", "updatedBy": "zYy3YOUuHxgomU1uYJty", "dnd": "{elements:[], attrs:{}, templateSettings:{}}", "html": "", "editorType": "html", "previewText": "zYy3YOUuHxgomU1uYJty", "isPlainText": "false"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 've9EPM428h8vShlRW1KT', 'templateId': 'zYy3YOUuHxgomU1uYJty', 'updatedBy': 'zYy3YOUuHxgomU1uYJty', 'dnd': '{elements:[], attrs:{}, templateSettings:{}}', 'html': '', 'editorType': 'html', 'previewText': 'zYy3YOUuHxgomU1uYJty', 'isPlainText': 'false'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Bulk Delete / Trash Files or Folders
Source: https://developers.leadwaycrm.com/api-reference/media-storage/media-storage-bulk-delete-media-objects
Soft-deletes or trashes multiple files and folders in a single request
Soft-deletes or trashes multiple files and folders in a single request
```http theme={null}
PUT https://services.leadconnectorhq.com/medias/delete-files
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Array of file objects to be deleted or trashed
Unique identifier of the file or folder to be deleted
Type of entity that owns the files Posibles valores: 'account'
Account identifier
Status to set for the files (deleted or trashed) Posibles valores: 'deleted', 'trashed'
## Respuestas
```json theme={null}
[
{
"deleted": true,
"id": "686f630df0d3166d68fbcec2"
}
]
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/medias/delete-files' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"filesToBeDeleted": [
{
"_id": "686f630df0d3166d68fbcec2"
}
],
"altType": "account",
"altId": "sx6wyHhbFdRXh302LLNR",
"status": "deleted"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/medias/delete-files', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"filesToBeDeleted": [{"_id": "686f630df0d3166d68fbcec2"}], "altType": "account", "altId": "sx6wyHhbFdRXh302LLNR", "status": "deleted"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/medias/delete-files',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"filesToBeDeleted": [{"_id": "686f630df0d3166d68fbcec2"}], "altType": "account", "altId": "sx6wyHhbFdRXh302LLNR", "status": "deleted"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'filesToBeDeleted': [{'_id': '686f630df0d3166d68fbcec2'}], 'altType': 'account', 'altId': 'sx6wyHhbFdRXh302LLNR', 'status': 'deleted'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Bulk Update Files/ Folders
Source: https://developers.leadwaycrm.com/api-reference/media-storage/media-storage-bulk-update-media-objects
Updates metadata or status of multiple files and folders
Updates metadata or status of multiple files and folders
```http theme={null}
PUT https://services.leadconnectorhq.com/medias/update-files
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account identifier
Type of entity that owns the files Posibles valores: 'account'
Array of file objects to be updated
Unique identifier of the file or folder to be updated
New name for the file or folder
## Respuestas
```json theme={null}
[
{
"updated": true,
"id": "686f9817f0d3165be9fbcef6"
}
]
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/medias/update-files' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "sx6wyHhbFdRXh302LLNR",
"altType": "account",
"filesToBeUpdated": [
{
"id": "686f9817f0d3165be9fbcef6",
"name": "Updated File Name.pdf"
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/medias/update-files', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "sx6wyHhbFdRXh302LLNR", "altType": "account", "filesToBeUpdated": [{"id": "686f9817f0d3165be9fbcef6", "name": "Updated File Name.pdf"}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/medias/update-files',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "sx6wyHhbFdRXh302LLNR", "altType": "account", "filesToBeUpdated": [{"id": "686f9817f0d3165be9fbcef6", "name": "Updated File Name.pdf"}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': 'sx6wyHhbFdRXh302LLNR', 'altType': 'account', 'filesToBeUpdated': [{'id': '686f9817f0d3165be9fbcef6', 'name': 'Updated File Name.pdf'}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Folder
Source: https://developers.leadwaycrm.com/api-reference/media-storage/media-storage-create-media-folder
Creates a new folder in the media storage
Creates a new folder in the media storage
```http theme={null}
POST https://services.leadconnectorhq.com/medias/folder
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
Type of entity (account only) Posibles valores: 'account'
Name of the folder to be created
ID of the parent folder (optional)
## Respuestas
Account identifier that owns this folder
Type of entity that owns the folder Posibles valores: 'account'
Name of the folder
ID of the parent folder (null for root folders)
Type of the object (always 'folder' for folders)
Whether the folder has been deleted
Whether there are pending uploads to this folder
Primary category of content stored in the folder
Sub-category of content stored in the folder
Whether the folder is private and not publicly accessible
Whether the folder has been moved from its original account
Whether the data migration process has been completed for this folder
Whether this is a system-generated application folder
Whether the folder is essential and should not be deleted
Current status of the folder
ID of the user who last updated the folder
```json theme={null}
{
"altId": "sx6wyHhbFdRXh302LLNR",
"altType": "account",
"name": "New Folder",
"parentId": "64af50c42d567a3b4f5989e0",
"type": "folder",
"deleted": false,
"pendingUpload": false,
"category": "image",
"subCategory": "logo",
"isPrivate": false,
"relocatedFolder": false,
"migrationCompleted": true,
"appFolder": false,
"isEssential": false,
"status": "string",
"lastUpdatedBy": "user-uuid-123"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/medias/folder' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "sx6wyHhbFdRXh302LLNR",
"altType": "account",
"name": "New Folder",
"parentId": "64af50c42d567a3b4f5989e0"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/medias/folder', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "sx6wyHhbFdRXh302LLNR", "altType": "account", "name": "New Folder", "parentId": "64af50c42d567a3b4f5989e0"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/medias/folder',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "sx6wyHhbFdRXh302LLNR", "altType": "account", "name": "New Folder", "parentId": "64af50c42d567a3b4f5989e0"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': 'sx6wyHhbFdRXh302LLNR', 'altType': 'account', 'name': 'New Folder', 'parentId': '64af50c42d567a3b4f5989e0'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete File or Folder
Source: https://developers.leadwaycrm.com/api-reference/media-storage/media-storage-delete-media-content
Deletes specific file or folder from the media storage
Deletes specific file or folder from the media storage
```http theme={null}
DELETE https://services.leadconnectorhq.com/medias/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
## Query parameters
AltType
account Id
## Respuestas
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/medias/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/medias/YOUR_id', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/medias/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get List of Files/ Folders
Source: https://developers.leadwaycrm.com/api-reference/media-storage/media-storage-fetch-media-content
Fetches list of files and folders from the media storage
Fetches list of files and folders from the media storage
```http theme={null}
GET https://services.leadconnectorhq.com/medias/files
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Number of files to skip in listing
Number of files to show in the listing
Field to sorting the file listing by
Direction in which file needs to be sorted
Type
Query text
AltType
account Id
parent id or folder id
Fetch all files or folders
## Respuestas
Array of File Objects
```json theme={null}
{
"files": {
"altId": "locationId",
"altType": "account",
"name": "file name",
"parentId": "parent folder id",
"url": "file url",
"path": "file path"
}
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/medias/files' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/medias/files', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/medias/files',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update File/ Folder
Source: https://developers.leadwaycrm.com/api-reference/media-storage/media-storage-update-media-object
Updates a single file or folder by ID
Updates a single file or folder by ID
```http theme={null}
POST https://services.leadconnectorhq.com/medias/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Unique identifier of the file or folder to update
## Body
New name for the file or folder
Type of entity that owns the file or folder Posibles valores: 'account'
Account identifier that owns the file or folder
## Respuestas
```json theme={null}
{
"updated": true,
"traceId": "33a641a2-c4a6-4123-aa82-c5b84f1a14ee"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/medias/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "Updated File Name.pdf",
"altType": "account",
"altId": "sx6wyHhbFdRXh302LLNR"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/medias/YOUR_id', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "Updated File Name.pdf", "altType": "account", "altId": "sx6wyHhbFdRXh302LLNR"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/medias/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "Updated File Name.pdf", "altType": "account", "altId": "sx6wyHhbFdRXh302LLNR"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'Updated File Name.pdf', 'altType': 'account', 'altId': 'sx6wyHhbFdRXh302LLNR'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Upload File into Media Storage
Source: https://developers.leadwaycrm.com/api-reference/media-storage/media-storage-upload-media-content
If hosted is set to true then fileUrl is required. Else file is required. If adding a file, maximum allowed is 25 MB
If hosted is set to true then fileUrl is required. Else file is required. If adding a file, maximum allowed is 25 MB
```http theme={null}
POST https://services.leadconnectorhq.com/medias/upload-file
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
## Respuestas
ID of the uploaded file
Google Cloud Storage URL of the uploaded file
```json theme={null}
{
"fileId": "file.pdf",
"url": "https://storage.googleapis.com/bucket-name/path/to/file.pdf"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/medias/upload-file' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"file": "string",
"hosted": true,
"fileUrl": "string",
"name": "string",
"parentId": "string"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/medias/upload-file', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"file": "string", "hosted": true, "fileUrl": "string", "name": "string", "parentId": "string"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/medias/upload-file',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"file": "string", "hosted": true, "fileUrl": "string", "name": "string", "parentId": "string"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'file': 'string', 'hosted': true, 'fileUrl': 'string', 'name': 'string', 'parentId': 'string'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Custom Object
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-create-custom-object-schema
Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0)
```http theme={null}
POST https://services.leadconnectorhq.com/objects/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
This is what your custom object will be called. These labels will be used to display your custom object on the UI
key that would be used to refer the Custom Object internally (lowercase + underscore\_separated). 'custom\_objects.' would be added as prefix by default
Pet Object\`s description
Account Id
Primary property which will be displayed on the record page
## Respuestas
id of the custom / standard object schema
false in case of custom objects and true in case of standard objects like contacts and opportunities
key that would be used to refer the custom / standard Object internally (lowercase + underscore\_separated). For custom objects, 'custom\_objects.' would be added as prefix by default
This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
Custom / Standard Object Descriptions for example , Pet Object\`s description
account's id
Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom\_objects.\{\{object\_key}} or business.\{\{object\_key}} (for company)' would be added as prefix by default for all the custom / standard objects
Date and time when the object was added
Date and time when the object was last updated
Object\`s Type
```json theme={null}
{
"object": {
"id": "661c06b4ffde146bdb469442",
"standard": false,
"key": "custom_objects.pet",
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "Q9DT3OAqEXDLYuob1G32",
"primaryDisplayProperty": "custom_objects.pet.name",
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z",
"type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/objects/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"key": "custom_objects.pet",
"description": "These are non vaccinated pets",
"locationId": "ve9EPM428h8vShlRW1KT"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"labels": {"singular": "Pet", "plural": "Pets"}, "key": "custom_objects.pet", "description": "These are non vaccinated pets", "locationId": "ve9EPM428h8vShlRW1KT"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/objects/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"labels": {"singular": "Pet", "plural": "Pets"}, "key": "custom_objects.pet", "description": "These are non vaccinated pets", "locationId": "ve9EPM428h8vShlRW1KT"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'labels': {'singular': 'Pet', 'plural': 'Pets'}, 'key': 'custom_objects.pet', 'description': 'These are non vaccinated pets', 'locationId': 've9EPM428h8vShlRW1KT'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Record
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-create-object-record
Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296
Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296)
```http theme={null}
POST https://services.leadconnectorhq.com/objects/{schemaKey}/records
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom\_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.
## Body
## Respuestas
id of the record
Owner (User's id). Limited to 1 for now. Only Supported with custom objects
Follower (User's ids). Limited to 10 for now
Properties of the record
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"record": {
"id": "661c06b4ffde146bdb469442",
"owner": [
"sx6wyHhbFdRXh302Lunr"
],
"followers": [
"sx6wyHhbFdRXh302Lunr",
"v5cEPM428h8vShlRW1KT"
],
"properties": {
"customer_number": 1424,
"ticket_name": "Customer not able login",
"phone_number": "+917000000000",
"money": {
"currency": "default",
"value": 100
},
"type_of_ticket": "doubt",
"section_of_app": [
"contacts",
"smartlist"
],
"recieved_on": "2024-07-11",
"my_files": [
{
"url": "---url_of_file---"
}
],
"my_textbox_list.option_a": "Value 1",
"my_textbox_list.option_b": "Value 2"
},
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(None),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Record
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-delete-object-record
Delete Record By Id . Supported Objects are business and custom objects.
Delete Record By Id . Supported Objects are business and custom objects.
```http theme={null}
DELETE https://services.leadconnectorhq.com/objects/{schemaKey}/records/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom\_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.
id of the record to be updated. Available on the Record details page under the 3 dots or in the url
## Respuestas
id of the deleted object
boolean that defines if the operation was a success or not
```json theme={null}
{
"id": "661c06b4ffde146bdb469442",
"success": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get all objects for a account
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-get-object-by-account-id
Get all objects for a account. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : https://doc.cli
Get all objects for a account. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0)
```http theme={null}
GET https://services.leadconnectorhq.com/objects/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
account id
## Respuestas
id of the custom / standard object schema
false in case of custom objects and true in case of standard objects like contacts and opportunities
key that would be used to refer the custom / standard Object internally (lowercase + underscore\_separated). For custom objects, 'custom\_objects.' would be added as prefix by default
This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
Custom / Standard Object Descriptions for example , Pet Object\`s description
account's id
Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom\_objects.\{\{object\_key}} or business.\{\{object\_key}} (for company)' would be added as prefix by default for all the custom / standard objects
Date and time when the object was added
Date and time when the object was last updated
Object\`s Type
```json theme={null}
{
"objects": [
{
"id": "661c06b4ffde146bdb469442",
"standard": false,
"key": "custom_objects.pet",
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "Q9DT3OAqEXDLYuob1G32",
"primaryDisplayProperty": "custom_objects.pet.name",
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z",
"type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
}
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/objects/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/objects/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Object Schema by key / id
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-get-object-schema-by-key
Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom obje
Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0)
```http theme={null}
GET https://services.leadconnectorhq.com/objects/{key}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
key of the custom or standard object. For custom objects, the key must include the prefix “custom\_objects.”. This key can be found on the Object Details page under Settings in the UI.
## Query parameters
account id of the sub account
Fetch Properties , Fetches all the standard / custom fields of the object when set to true
## Respuestas
id of the custom / standard object schema
false in case of custom objects and true in case of standard objects like contacts and opportunities
key that would be used to refer the custom / standard Object internally (lowercase + underscore\_separated). For custom objects, 'custom\_objects.' would be added as prefix by default
This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
Custom / Standard Object Descriptions for example , Pet Object\`s description
account's id
Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom\_objects.\{\{object\_key}} or business.\{\{object\_key}} (for company)' would be added as prefix by default for all the custom / standard objects
Date and time when the object was added
Date and time when the object was last updated
Object\`s Type
Is the response served from cache
Account Id
Field name
Description of the field
Placeholder text for the field
Whether the field should be shown in forms
Options for the field (Optional, valid only for SINGLE\_OPTIONS, MULTIPLE\_OPTIONS, RADIO, CHECKBOX, TEXTBOX\_LIST type)
Key of the option (Included in Create and Response, excluded in Update)
Value of the option
URL associated with the option (Optional, valid only for RADIO type)
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Posibles valores: '.pdf', '.docx', '.doc', '.jpg', '.jpeg', '.png', '.gif', '.csv', '.xlsx', '.xls', 'all'
Unique identifier of the object
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom\_object.pet" for a custom object related to pets.
Type of field that you are trying to create Posibles valores: 'TEXT', 'LARGE\_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE\_OPTIONS', 'MULTIPLE\_OPTIONS', 'DATE', 'TEXTBOX\_LIST', 'FILE\_UPLOAD', 'RADIO'
ID of the parent folder
Field key. For Custom Object it's formatted as "custom\_object.\{objectKey}.\{fieldKey}". "custom\_object" is a fixed prefix, "\{objectKey}" is your custom object's identifier, and "\{fieldName}" is the unique field name within that object. Example: "custom\_object.pet.name" for a "name" field in a "pet" custom object.
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Maximum file limit for uploads
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"object": {
"id": "661c06b4ffde146bdb469442",
"standard": false,
"key": "custom_objects.pet",
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "Q9DT3OAqEXDLYuob1G32",
"primaryDisplayProperty": "custom_objects.pet.name",
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z",
"type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
},
"cache": true,
"fields": [
{
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "Name",
"description": "string",
"placeholder": "string",
"showInForms": true,
"options": [
{}
],
"acceptedFormats": ".pdf",
"id": "string",
"objectKey": "custom_object.pet",
"dataType": "TEXT",
"parentId": "3v34PM428h8vShlRW1KT",
"fieldKey": "custom_object.pet.name",
"allowCustomOption": true,
"maxFileLimit": 2,
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/objects/YOUR_key' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/YOUR_key', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/objects/YOUR_key',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Record By Id
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-get-record-by-id
Allows you to get a Standard Object like business and custom object record by Id
Allows you to get a Standard Object like business and custom object record by Id
```http theme={null}
GET https://services.leadconnectorhq.com/objects/{schemaKey}/records/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom\_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.
id of the record to be updated. Available on the Record details page under the 3 dots or in the url
## Respuestas
id of the record
Owner (User's id). Limited to 1 for now. Only Supported with custom objects
Follower (User's ids). Limited to 10 for now
Properties of the record
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"record": {
"id": "661c06b4ffde146bdb469442",
"owner": [
"sx6wyHhbFdRXh302Lunr"
],
"followers": [
"sx6wyHhbFdRXh302Lunr",
"v5cEPM428h8vShlRW1KT"
],
"properties": {
"customer_number": 1424,
"ticket_name": "Customer not able login",
"phone_number": "+917000000000",
"money": {
"currency": "default",
"value": 100
},
"type_of_ticket": "doubt",
"section_of_app": [
"contacts",
"smartlist"
],
"recieved_on": "2024-07-11",
"my_files": [
{
"url": "---url_of_file---"
}
],
"my_textbox_list.option_a": "Value 1",
"my_textbox_list.option_b": "Value 2"
},
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Search Object Records
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-search-object-records
Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336
Supported Objects are custom objects and standard objects like "business". Documentation Link - [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336)
```http theme={null}
POST https://services.leadconnectorhq.com/objects/{schemaKey}/records/search
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
custom object key
## Body
Account Id
Page
Page Limit
Pass this query parameter to search using your searchable properties. For example, if you have a custom object called “Pets” and have configured “name” as a searchable property, you can pass name:Buddy to search for pets with the name “Buddy.”
## Respuestas
Records
id of the record
Owner (User's id). Limited to 1 for now . Only supported for custom objects for now
Follower (User's ids). Limited to 10 and supported for custom objects for now
Properties of the record
Date and time when the object was added
Date and time when the object was last updated
Account Id
ObjectId Id
ObjectId key
Created By Meta
Last Updated By Meta
Total Number of records
```json theme={null}
{
"records": [
{
"id": "661c06b4ffde146bdb469442",
"owner": [
"sx6wyHhbFdRXh302Lunr"
],
"followers": [
"sx6wyHhbFdRXh302Lunr",
"v5cEPM428h8vShlRW1KT"
],
"properties": {
"customer_number": 1424,
"ticket_name": "Customer not able login",
"phone_number": "+917000000000",
"money": {
"currency": "default",
"value": 100
},
"type_of_ticket": "doubt",
"section_of_app": [
"contacts",
"smartlist"
],
"recieved_on": "2024-07-11",
"my_files": [
{
"url": "---url_of_file---"
}
],
"my_textbox_list.option_a": "Value 1",
"my_textbox_list.option_b": "Value 2"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z",
"locationId": "ve9EPM428h8vShlRW1KT",
"objectId": "6d6f6e676f5f6576656e7473",
"objectKey": "custom_objects.pet",
"searchAfter": [
// truncado: 7 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/search' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "ve9EPM428h8vShlRW1KT",
"page": 1,
"pageLimit": 10,
"query": "Buddy",
"searchAfter": [
"sx6wyHhbFdRXh302Lunr",
"sx6wyHhbFdRXh302Lunr"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "ve9EPM428h8vShlRW1KT", "page": 1, "pageLimit": 10, "query": "Buddy", "searchAfter": ["sx6wyHhbFdRXh302Lunr", "sx6wyHhbFdRXh302Lunr"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/search',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "ve9EPM428h8vShlRW1KT", "page": 1, "pageLimit": 10, "query": "Buddy", "searchAfter": ["sx6wyHhbFdRXh302Lunr", "sx6wyHhbFdRXh302Lunr"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 've9EPM428h8vShlRW1KT', 'page': 1, 'pageLimit': 10, 'query': 'Buddy', 'searchAfter': ['sx6wyHhbFdRXh302Lunr', 'sx6wyHhbFdRXh302Lunr']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Object Schema By Key / Id
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-update-custom-object
Update Custom Object Schema or standard objects like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.cl
Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0)
```http theme={null}
PUT https://services.leadconnectorhq.com/objects/{key}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
key of the custom or standard object. For custom objects, the key must include the prefix “custom\_objects.”. This key can be found on the Object Details page under Settings in the UI.
## Body
This is how your custom object will be displayed
Pet Object\`s description
account id
Searchable Fields: Provide the field key of your object that you want to search on, using the format (custom\_object.\.\).
## Respuestas
id of the custom / standard object schema
false in case of custom objects and true in case of standard objects like contacts and opportunities
key that would be used to refer the custom / standard Object internally (lowercase + underscore\_separated). For custom objects, 'custom\_objects.' would be added as prefix by default
This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
Custom / Standard Object Descriptions for example , Pet Object\`s description
account's id
Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom\_objects.\{\{object\_key}} or business.\{\{object\_key}} (for company)' would be added as prefix by default for all the custom / standard objects
Date and time when the object was added
Date and time when the object was last updated
Object\`s Type
```json theme={null}
{
"object": {
"id": "661c06b4ffde146bdb469442",
"standard": false,
"key": "custom_objects.pet",
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "Q9DT3OAqEXDLYuob1G32",
"primaryDisplayProperty": "custom_objects.pet.name",
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z",
"type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/objects/YOUR_key' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"labels": {
"singular": "Pet",
"plural": "Pets"
},
"description": "These are non vaccinated pets",
"locationId": "632c34b4c9b7da3358ac9891",
"searchableProperties": [
"custom_objects.mad.mad",
"custom_objects.mad.record_1",
"custom_objects.mad.nn"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/YOUR_key', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"labels": {"singular": "Pet", "plural": "Pets"}, "description": "These are non vaccinated pets", "locationId": "632c34b4c9b7da3358ac9891", "searchableProperties": ["custom_objects.mad.mad", "custom_objects.mad.record_1", "custom_objects.mad.nn"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/objects/YOUR_key',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"labels": {"singular": "Pet", "plural": "Pets"}, "description": "These are non vaccinated pets", "locationId": "632c34b4c9b7da3358ac9891", "searchableProperties": ["custom_objects.mad.mad", "custom_objects.mad.record_1", "custom_objects.mad.nn"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'labels': {'singular': 'Pet', 'plural': 'Pets'}, 'description': 'These are non vaccinated pets', 'locationId': '632c34b4c9b7da3358ac9891', 'searchableProperties': ['custom_objects.mad.mad', 'custom_objects.mad.record_1', 'custom_objects.mad.nn']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Record
Source: https://developers.leadwaycrm.com/api-reference/objects/objects-update-object-record
Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296
Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - [https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296](https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296)
```http theme={null}
PUT https://services.leadconnectorhq.com/objects/{schemaKey}/records/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom\_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.
id of the record to be updated. Available on the Record details page under the 3 dots or in the url
## Query parameters
## Body
## Respuestas
id of the record
Owner (User's id). Limited to 1 for now. Only Supported with custom objects
Follower (User's ids). Limited to 10 for now
Properties of the record
Date and time when the object was added
Date and time when the object was last updated
```json theme={null}
{
"record": {
"id": "661c06b4ffde146bdb469442",
"owner": [
"sx6wyHhbFdRXh302Lunr"
],
"followers": [
"sx6wyHhbFdRXh302Lunr",
"v5cEPM428h8vShlRW1KT"
],
"properties": {
"customer_number": 1424,
"ticket_name": "Customer not able login",
"phone_number": "+917000000000",
"money": {
"currency": "default",
"value": 100
},
"type_of_ticket": "doubt",
"section_of_app": [
"contacts",
"smartlist"
],
"recieved_on": "2024-07-11",
"my_files": [
{
"url": "---url_of_file---"
}
],
"my_textbox_list.option_a": "Value 1",
"my_textbox_list.option_b": "Value 2"
},
"dateAdded": "2024-01-15T10:30:00Z",
"dateUpdated": "2024-01-15T10:30:00Z"
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/objects/YOUR_schemaKey/records/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(None),
]);
$data = json_decode(curl_exec($ch), true);
```
# Add Followers
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-add-followers-opportunity
Add Followers
Add Followers
```http theme={null}
POST https://services.leadconnectorhq.com/opportunities/{id}/followers
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Opportunity Id
## Body
## Respuestas
```json theme={null}
{
"followers": [
"sx6wyHhbFdRXh302Lunr",
"sx6wyHhbFdRXh302LLss"
],
"followersAdded": [
"Mx6wyHhbFdRXh302Luer",
"Ka6wyHhbFdRXh302LLsAm"
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/opportunities/YOUR_id/followers' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"followers": [
"sx6wyHhbFdRXh302Lunr",
"sx6wyHhbFdRXh302Lunr"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/YOUR_id/followers', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"followers": ["sx6wyHhbFdRXh302Lunr", "sx6wyHhbFdRXh302Lunr"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/opportunities/YOUR_id/followers',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"followers": ["sx6wyHhbFdRXh302Lunr", "sx6wyHhbFdRXh302Lunr"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'followers': ['sx6wyHhbFdRXh302Lunr', 'sx6wyHhbFdRXh302Lunr']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Opportunity
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-create-opportunity
Create Opportunity
Create Opportunity
```http theme={null}
POST https://services.leadconnectorhq.com/opportunities/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
pipeline Id
Posibles valores: 'open', 'won', 'lost', 'abandoned', 'all'
Add custom fields to opportunities.
## Respuestas
The value of the custom field
```json theme={null}
{
"opportunity": {
"id": "yWQobCRIhRguQtD2llvk",
"name": "testing",
"monetaryValue": 500,
"pipelineId": "VDm7RPYC2GLUvdpKmBfC",
"pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
"assignedTo": "zT46WSCPbudrq4zhWMk6",
"status": "open",
"source": "",
"lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
"lastStageChangeAt": "2021-08-03T04:55:17.355Z",
"lastActionDate": "2021-08-03T04:55:17.355Z",
"indexVersion": 1,
"createdAt": "2021-08-03T04:55:17.355Z",
"updatedAt": "2021-08-03T04:55:17.355Z",
"contactId": "zT46WSCPbudrq4zhWMk6",
"locationId": "zT46WSCPbudrq4zhW",
"contact": {
"id": "byMEV0NQinDhq8ZfiOi2",
"name": "John Deo",
"companyName": "Tesla Inc",
"email": "john@deo.com",
"phone": "+1202-555-0107",
"tags": [
"string"
]
},
"notes": [
[]
],
"tasks": [
[]
],
"calendarEvents": [
[]
],
"lostReasonId": "zT46WSCPbudrq4zhWMk6",
"customFields": [
// truncado: 10 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/opportunities/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"pipelineId": "VDm7RPYC2GLUvdpKmBfC",
"locationId": "ve9EPM428h8vShlRW1KT",
"name": "First Opps",
"pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
"status": "open",
"contactId": "mTkSCb1UBjb5tk4OvB69",
"monetaryValue": 220,
"assignedTo": "082goXVW3lIExEQPOnd3",
"customFields": []
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"pipelineId": "VDm7RPYC2GLUvdpKmBfC", "locationId": "ve9EPM428h8vShlRW1KT", "name": "First Opps", "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10", "status": "open", "contactId": "mTkSCb1UBjb5tk4OvB69", "monetaryValue": 220, "assignedTo": "082goXVW3lIExEQPOnd3", "customFields": []}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/opportunities/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"pipelineId": "VDm7RPYC2GLUvdpKmBfC", "locationId": "ve9EPM428h8vShlRW1KT", "name": "First Opps", "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10", "status": "open", "contactId": "mTkSCb1UBjb5tk4OvB69", "monetaryValue": 220, "assignedTo": "082goXVW3lIExEQPOnd3", "customFields": []},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'pipelineId': 'VDm7RPYC2GLUvdpKmBfC', 'locationId': 've9EPM428h8vShlRW1KT', 'name': 'First Opps', 'pipelineStageId': '7915dedc-8f18-44d5-8bc3-77c04e994a10', 'status': 'open', 'contactId': 'mTkSCb1UBjb5tk4OvB69', 'monetaryValue': 220, 'assignedTo': '082goXVW3lIExEQPOnd3', 'customFields': []}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Opportunity
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-delete-opportunity
Delete Opportunity
Delete Opportunity
```http theme={null}
DELETE https://services.leadconnectorhq.com/opportunities/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Opportunity Id
## Respuestas
```json theme={null}
{
"succeded": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/opportunities/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/YOUR_id', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/opportunities/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get lost reason
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-get-lost-reason
Get lost reason
Get lost reason
```http theme={null}
GET https://services.leadconnectorhq.com/opportunities/lost-reason
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
lost reason name
deleted
search query
skip
limit
get count
## Respuestas
lost reason id
lost reason name
account id
updated at
created at
```json theme={null}
{
"lostReasons": [
{
"id": "ve9EPM428h8vShlRW1KT",
"name": "lost reason",
"locationId": "location_id",
"updatedAt": "2023-06-19T12:04:22.488Z",
"createdAt": "2023-06-19T12:04:22.488Z"
}
],
"total": 100
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/opportunities/lost-reason' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/lost-reason', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/opportunities/lost-reason',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Opportunity
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-get-opportunity
Get Opportunity
Get Opportunity
```http theme={null}
GET https://services.leadconnectorhq.com/opportunities/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Opportunity Id
## Respuestas
The value of the custom field
```json theme={null}
{
"opportunity": {
"id": "yWQobCRIhRguQtD2llvk",
"name": "testing",
"monetaryValue": 500,
"pipelineId": "VDm7RPYC2GLUvdpKmBfC",
"pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
"assignedTo": "zT46WSCPbudrq4zhWMk6",
"status": "open",
"source": "",
"lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
"lastStageChangeAt": "2021-08-03T04:55:17.355Z",
"lastActionDate": "2021-08-03T04:55:17.355Z",
"indexVersion": 1,
"createdAt": "2021-08-03T04:55:17.355Z",
"updatedAt": "2021-08-03T04:55:17.355Z",
"contactId": "zT46WSCPbudrq4zhWMk6",
"locationId": "zT46WSCPbudrq4zhW",
"contact": {
"id": "byMEV0NQinDhq8ZfiOi2",
"name": "John Deo",
"companyName": "Tesla Inc",
"email": "john@deo.com",
"phone": "+1202-555-0107",
"tags": [
"string"
]
},
"notes": [
[]
],
"tasks": [
[]
],
"calendarEvents": [
[]
],
"lostReasonId": "zT46WSCPbudrq4zhWMk6",
"customFields": [
// truncado: 10 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/opportunities/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/YOUR_id', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/opportunities/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Pipelines
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-get-pipelines
Get Pipelines
Get Pipelines
```http theme={null}
GET https://services.leadconnectorhq.com/opportunities/pipelines
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
## Respuestas
How pipeline/stage colors are rendered Posibles valores: 'dot', 'bg-tint', 'none'
```json theme={null}
{
"pipelines": [
{
"id": "aWdODOBVOlH1RUFKWQke",
"name": "new pipeline",
"stages": [
[]
],
"showInFunnel": false,
"showInPieChart": true,
"locationId": "dsjddjkndadqaja",
"colorRenderMode": "dot"
}
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/opportunities/pipelines' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/pipelines', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/opportunities/pipelines',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Remove Followers
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-remove-followers-opportunity
Allows removal of one or all followers from an opportunity.
Allows removal of one or all followers from an opportunity.
```http theme={null}
DELETE https://services.leadconnectorhq.com/opportunities/{id}/followers
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Opportunity Id
## Query parameters
## Body
## Respuestas
```json theme={null}
{
"followers": [
"sx6wyHhbFdRXh302Lunr",
"sx6wyHhbFdRXh302LLss"
],
"followersRemoved": [
"Mx6wyHhbFdRXh302Luer",
"Ka6wyHhbFdRXh302LLsAm"
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/opportunities/YOUR_id/followers' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"followers": [
"sx6wyHhbFdRXh302Lunr",
"sx6wyHhbFdRXh302Lunr"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/YOUR_id/followers', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"followers": ["sx6wyHhbFdRXh302Lunr", "sx6wyHhbFdRXh302Lunr"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/opportunities/YOUR_id/followers',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"followers": ["sx6wyHhbFdRXh302Lunr", "sx6wyHhbFdRXh302Lunr"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'followers': ['sx6wyHhbFdRXh302Lunr', 'sx6wyHhbFdRXh302Lunr']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Search Opportunities
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-search-opportunities-advanced
Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f
Search Opportunities based on combinations of advanced filters. Documentation Link - [https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f](https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f)
```http theme={null}
POST https://services.leadconnectorhq.com/opportunities/search
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
## Respuestas
The value of the custom field
```json theme={null}
{
"opportunities": [
{
"id": "yWQobCRIhRguQtD2llvk",
"name": "testing",
"monetaryValue": 500,
"pipelineId": "VDm7RPYC2GLUvdpKmBfC",
"pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
"assignedTo": "zT46WSCPbudrq4zhWMk6",
"status": "open",
"source": "",
"lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
"lastStageChangeAt": "2021-08-03T04:55:17.355Z",
"lastActionDate": "2021-08-03T04:55:17.355Z",
"indexVersion": 1,
"createdAt": "2021-08-03T04:55:17.355Z",
"updatedAt": "2021-08-03T04:55:17.355Z",
"contactId": "zT46WSCPbudrq4zhWMk6",
"locationId": "zT46WSCPbudrq4zhW",
"contact": {
"id": "byMEV0NQinDhq8ZfiOi2",
"name": "John Deo",
"companyName": "Tesla Inc",
"email": "john@deo.com",
"phone": "+1202-555-0107",
"tags": []
},
"notes": [
[]
],
"tasks": [
[]
],
"calendarEvents": [
[]
],
"lostReasonId": "zT46WSCPbudrq4zhWMk6",
"customFields": [
{}
// truncado: 10 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/opportunities/search' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "i2SpAtBVHSVea1sL6oah",
"query": "string",
"limit": 0,
"page": 0,
"searchAfter": [
"string"
],
"additionalDetails": {
"notes": true,
"tasks": true,
"calendarEvents": true,
"unReadConversations": true
}
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "i2SpAtBVHSVea1sL6oah", "query": "string", "limit": 0, "page": 0, "searchAfter": ["string"], "additionalDetails": {"notes": true, "tasks": true, "calendarEvents": true, "unReadConversations": true}}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/opportunities/search',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "i2SpAtBVHSVea1sL6oah", "query": "string", "limit": 0, "page": 0, "searchAfter": ["string"], "additionalDetails": {"notes": true, "tasks": true, "calendarEvents": true, "unReadConversations": true}},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 'i2SpAtBVHSVea1sL6oah', 'query': 'string', 'limit': 0, 'page': 0, 'searchAfter': ['string'], 'additionalDetails': {'notes': true, 'tasks': true, 'calendarEvents': true, 'unReadConversations': true}}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Search Opportunity
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-search-opportunity
Search Opportunity
Search Opportunity
```http theme={null}
GET https://services.leadconnectorhq.com/opportunities/search
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id
Pipeline Id
stage Id
Contact Id
Campaign Id
Opportunity Id
End date
Start After
Start After Id
Start date
Limit Per Page records count. will allow maximum up to 100 and default will be 20
get Tasks in contact
get Notes in contact
get Calendar event in contact
## Respuestas
The value of the custom field
```json theme={null}
{
"opportunities": [
{
"id": "yWQobCRIhRguQtD2llvk",
"name": "testing",
"monetaryValue": 500,
"pipelineId": "VDm7RPYC2GLUvdpKmBfC",
"pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
"assignedTo": "zT46WSCPbudrq4zhWMk6",
"status": "open",
"source": "",
"lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
"lastStageChangeAt": "2021-08-03T04:55:17.355Z",
"lastActionDate": "2021-08-03T04:55:17.355Z",
"indexVersion": 1,
"createdAt": "2021-08-03T04:55:17.355Z",
"updatedAt": "2021-08-03T04:55:17.355Z",
"contactId": "zT46WSCPbudrq4zhWMk6",
"locationId": "zT46WSCPbudrq4zhW",
"contact": {
"id": "byMEV0NQinDhq8ZfiOi2",
"name": "John Deo",
"companyName": "Tesla Inc",
"email": "john@deo.com",
"phone": "+1202-555-0107",
"tags": []
},
"notes": [
[]
],
"tasks": [
[]
],
"calendarEvents": [
[]
],
"lostReasonId": "zT46WSCPbudrq4zhWMk6",
"customFields": [
{}
// truncado: 18 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/opportunities/search' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/search', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/opportunities/search',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Opportunity
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-update-opportunity
Update Opportunity
Update Opportunity
```http theme={null}
PUT https://services.leadconnectorhq.com/opportunities/{id}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Opportunity Id
## Body
pipeline Id
Posibles valores: 'open', 'won', 'lost', 'abandoned', 'all'
Update custom fields to opportunities.
## Respuestas
The value of the custom field
```json theme={null}
{
"opportunity": {
"id": "yWQobCRIhRguQtD2llvk",
"name": "testing",
"monetaryValue": 500,
"pipelineId": "VDm7RPYC2GLUvdpKmBfC",
"pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
"assignedTo": "zT46WSCPbudrq4zhWMk6",
"status": "open",
"source": "",
"lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
"lastStageChangeAt": "2021-08-03T04:55:17.355Z",
"lastActionDate": "2021-08-03T04:55:17.355Z",
"indexVersion": 1,
"createdAt": "2021-08-03T04:55:17.355Z",
"updatedAt": "2021-08-03T04:55:17.355Z",
"contactId": "zT46WSCPbudrq4zhWMk6",
"locationId": "zT46WSCPbudrq4zhW",
"contact": {
"id": "byMEV0NQinDhq8ZfiOi2",
"name": "John Deo",
"companyName": "Tesla Inc",
"email": "john@deo.com",
"phone": "+1202-555-0107",
"tags": [
"string"
]
},
"notes": [
[]
],
"tasks": [
[]
],
"calendarEvents": [
[]
],
"lostReasonId": "zT46WSCPbudrq4zhWMk6",
"customFields": [
// truncado: 10 lineas mas
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/opportunities/YOUR_id' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"pipelineId": "bCkKGpDsyPP4peuKowkG",
"name": "First Opps",
"pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
"status": "open",
"monetaryValue": 220,
"assignedTo": "082goXVW3lIExEQPOnd3",
"customFields": []
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/YOUR_id', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"pipelineId": "bCkKGpDsyPP4peuKowkG", "name": "First Opps", "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10", "status": "open", "monetaryValue": 220, "assignedTo": "082goXVW3lIExEQPOnd3", "customFields": []}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/opportunities/YOUR_id',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"pipelineId": "bCkKGpDsyPP4peuKowkG", "name": "First Opps", "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10", "status": "open", "monetaryValue": 220, "assignedTo": "082goXVW3lIExEQPOnd3", "customFields": []},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'pipelineId': 'bCkKGpDsyPP4peuKowkG', 'name': 'First Opps', 'pipelineStageId': '7915dedc-8f18-44d5-8bc3-77c04e994a10', 'status': 'open', 'monetaryValue': 220, 'assignedTo': '082goXVW3lIExEQPOnd3', 'customFields': []}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Opportunity Status
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-update-opportunity-status
Update Opportunity Status
Update Opportunity Status
```http theme={null}
PUT https://services.leadconnectorhq.com/opportunities/{id}/status
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Opportunity Id
## Body
Posibles valores: 'open', 'won', 'lost', 'abandoned', 'all'
lost reason Id
## Respuestas
```json theme={null}
{
"succeded": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/opportunities/YOUR_id/status' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"status": "open",
"lostReasonId": "CLu7BaljjqrEjBGKTNNe"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/YOUR_id/status', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"status": "open", "lostReasonId": "CLu7BaljjqrEjBGKTNNe"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/opportunities/YOUR_id/status',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"status": "open", "lostReasonId": "CLu7BaljjqrEjBGKTNNe"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'status': 'open', 'lostReasonId': 'CLu7BaljjqrEjBGKTNNe'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Upsert Opportunity
Source: https://developers.leadwaycrm.com/api-reference/opportunities/opportunities-upsert-opportunity
Upsert Opportunity
Upsert Opportunity
```http theme={null}
POST https://services.leadconnectorhq.com/opportunities/upsert
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
opportunityId
pipeline Id
locationId
contactId
isRemoveAllFollowers
followers action type Posibles valores: 'add', 'remove'
name
Posibles valores: 'open', 'won', 'lost', 'abandoned', 'all'
lost reason Id
## Respuestas
Updated / New Opportunity
```json theme={null}
{
"opportunity": {},
"new": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/opportunities/upsert' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"id": "yWQobCRIhRguQtD2llvk",
"pipelineId": "bCkKGpDsyPP4peuKowkG",
"locationId": "CLu7BaljjqrEjBGKTNNe",
"followers": "LiKJ2vnRg5ETM8Z19K7",
"isRemoveAllFollowers": true,
"followersActionType": "add",
"name": "opportunity name",
"status": "open",
"pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
"monetaryValue": 220,
"assignedTo": "082goXVW3lIExEQPOnd3",
"lostReasonId": "CLu7BaljjqrEjBGKTNNe"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/opportunities/upsert', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"id": "yWQobCRIhRguQtD2llvk", "pipelineId": "bCkKGpDsyPP4peuKowkG", "locationId": "CLu7BaljjqrEjBGKTNNe", "followers": "LiKJ2vnRg5ETM8Z19K7", "isRemoveAllFollowers": true, "followersActionType": "add", "name": "opportunity name", "status": "open", "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10", "monetaryValue": 220, "assignedTo": "082goXVW3lIExEQPOnd3", "lostReasonId": "CLu7BaljjqrEjBGKTNNe"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/opportunities/upsert',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"id": "yWQobCRIhRguQtD2llvk", "pipelineId": "bCkKGpDsyPP4peuKowkG", "locationId": "CLu7BaljjqrEjBGKTNNe", "followers": "LiKJ2vnRg5ETM8Z19K7", "isRemoveAllFollowers": true, "followersActionType": "add", "name": "opportunity name", "status": "open", "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10", "monetaryValue": 220, "assignedTo": "082goXVW3lIExEQPOnd3", "lostReasonId": "CLu7BaljjqrEjBGKTNNe"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'id': 'yWQobCRIhRguQtD2llvk', 'pipelineId': 'bCkKGpDsyPP4peuKowkG', 'locationId': 'CLu7BaljjqrEjBGKTNNe', 'followers': 'LiKJ2vnRg5ETM8Z19K7', 'isRemoveAllFollowers': true, 'followersActionType': 'add', 'name': 'opportunity name', 'status': 'open', 'pipelineStageId': '7915dedc-8f18-44d5-8bc3-77c04e994a10', 'monetaryValue': 220, 'assignedTo': '082goXVW3lIExEQPOnd3', 'lostReasonId': 'CLu7BaljjqrEjBGKTNNe'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create new provider config
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-create-config
API to create a new payment config for given account
API to create a new payment config for given account
```http theme={null}
POST https://services.leadconnectorhq.com/payments/custom-provider/connect
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account id
## Body
Live config containing api-key and publishable key for live payments
Test config containing api-key and publishable-key for test payments
## Respuestas
The name of the custom provider
Description of payment gateway. Shown on the payments integrations page as subtext
This url will be loaded in iFrame to start a payment session.
The url used for querying payments related events. Ex. verify, refund, subscription etc.
Public image url for logo of the payment gateway displayed on the payments integrations page.
The unique identifier for the custom provider.
Account id
The application id of marketplace
Payment provider details.
Whether the config is deleted or not. true represents config is deleted
The creation timestamp of the custom provider.
The last update timestamp of the custom provider.
Trace id of the custom provider.
```json theme={null}
{
"name": "Company Paypal Integration",
"description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.",
"paymentsUrl": "https://testpayment.paypal.com",
"queryUrl": "https://testsubscription.paypal.com",
"imageUrl": "https://testsubscription.paypal.com",
"_id": "662a44ad19a2a44d3cd9d749",
"locationId": "Lk3nlfk4lxlelVEwcW",
"marketplaceAppId": "65f0b217a05c774da7f1efa5",
"paymentProvider": "{ live: { liveMode: true }, test: { liveMode: false, apiKey: \"y5ZQxryRFXZHvUJZdLXXXXXX\", publishableKey: \"rzp_test_zPRoVMLOa0A9wo\" }}",
"deleted": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"traceId": "302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/payments/custom-provider/connect' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/custom-provider/connect', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/payments/custom-provider/connect',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(None),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Coupon
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-create-coupon
The "Create Coupon" API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and applicable products. Use this endpoint to
The "Create Coupon" API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and applicable products. Use this endpoint to set up promotional offers and special discounts for your customers.
```http theme={null}
POST https://services.leadconnectorhq.com/payments/coupon
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
Alt Type Posibles valores: 'account'
Coupon Name
Coupon Code
Discount Type Posibles valores: 'percentage', 'amount'
Discount Value
Start date in YYYY-MM-DDTHH:mm:ssZ format
End date in YYYY-MM-DDTHH:mm:ssZ format
Max number of times coupon can be used
Product Ids
Is Coupon applicable on upcoming subscription transactions
If coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription
Limits whether a coupon can be redeemed only once per customer.
## Respuestas
Unique MongoDB identifier for the coupon
Number of times the coupon has been used
Maximum number of times a customer can use this coupon (0 for unlimited)
Account Id
Type of entity
Display name of the coupon
Redemption code for the coupon
Type of discount (percentage or amount) Posibles valores: 'percentage', 'amount'
Value of the discount (percentage or fixed amount)
Current status of the coupon Posibles valores: 'scheduled', 'active', 'expired'
Date when the coupon becomes active
End date when the coupon expires
Indicates if the coupon applies to future recurring payments
Configuration for how the coupon applies to future payments
User ID associated with the coupon (if applicable)
Creation timestamp
Last update timestamp
Unique identifier for tracing this API request
```json theme={null}
{
"_id": "67f6c132d9485f9dacd5f123",
"usageCount": 12,
"limitPerCustomer": 5,
"altId": "79t07PzK8Tvf73d12312",
"altType": "account",
"name": "NEWT6",
"code": "NEWT6",
"discountType": "percentage",
"discountValue": 25,
"status": "scheduled",
"startDate": "2025-04-30T18:30:00.000Z",
"endDate": "2025-05-30T18:30:00.000Z",
"applyToFuturePayments": true,
"userId": "q0m15dTLGeiGOXG123123",
"createdAt": "2025-04-09T18:49:22.026Z",
"updatedAt": "2025-04-09T18:49:22.026Z",
"traceId": "c667b18d-8f5e-44cf-a914"
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/payments/coupon' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "BQdAwxa0ky1iK2sstLGJ",
"altType": "account",
"name": "New Year Sale",
"code": "LEVELUPDAY2022",
"discountType": "amount",
"discountValue": 10,
"startDate": "2023-01-01T22:45:00.000Z",
"endDate": "2023-01-31T22:45:00.000Z",
"usageLimit": 10,
"productIds": [
"6241712be68f7a98102ba272"
],
"applyToFuturePayments": true,
"applyToFuturePaymentsConfig": [
{
"type": "fixed",
"duration": 5,
"durationType": "months"
},
{
"type": "forever"
}
],
"limitPerCustomer": true
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/coupon', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "name": "New Year Sale", "code": "LEVELUPDAY2022", "discountType": "amount", "discountValue": 10, "startDate": "2023-01-01T22:45:00.000Z", "endDate": "2023-01-31T22:45:00.000Z", "usageLimit": 10, "productIds": ["6241712be68f7a98102ba272"], "applyToFuturePayments": true, "applyToFuturePaymentsConfig": [{"type": "fixed", "duration": 5, "durationType": "months"}, {"type": "forever"}], "limitPerCustomer": true}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/payments/coupon',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "name": "New Year Sale", "code": "LEVELUPDAY2022", "discountType": "amount", "discountValue": 10, "startDate": "2023-01-01T22:45:00.000Z", "endDate": "2023-01-31T22:45:00.000Z", "usageLimit": 10, "productIds": ["6241712be68f7a98102ba272"], "applyToFuturePayments": true, "applyToFuturePaymentsConfig": [{"type": "fixed", "duration": 5, "durationType": "months"}, {"type": "forever"}], "limitPerCustomer": true},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': 'BQdAwxa0ky1iK2sstLGJ', 'altType': 'account', 'name': 'New Year Sale', 'code': 'LEVELUPDAY2022', 'discountType': 'amount', 'discountValue': 10, 'startDate': '2023-01-01T22:45:00.000Z', 'endDate': '2023-01-31T22:45:00.000Z', 'usageLimit': 10, 'productIds': ['6241712be68f7a98102ba272'], 'applyToFuturePayments': true, 'applyToFuturePaymentsConfig': [{'type': 'fixed', 'duration': 5, 'durationType': 'months'}, {'type': 'forever'}], 'limitPerCustomer': true}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create new integration
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-create-integration
API to create a new association for an app and account
API to create a new association for an app and account
```http theme={null}
POST https://services.leadconnectorhq.com/payments/custom-provider/provider
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account id
## Body
The name of the custom provider
Description of payment gateway. Shown on the payments integrations page as subtext
This url will be loaded in iFrame to start a payment session.
The url used for querying payments related events. Ex. verify, refund, subscription etc.
Public image url for logo of the payment gateway displayed on the payments integrations page.
Whether the config supports subscription schedule or not. true represents config supports subscription schedule
## Respuestas
The name of the custom provider
Description of payment gateway. Shown on the payments integrations page as subtext
This url will be loaded in iFrame to start a payment session.
The url used for querying payments related events. Ex. verify, refund, subscription etc.
Public image url for logo of the payment gateway displayed on the payments integrations page.
The unique identifier for the custom provider.
Account id
The application id of marketplace
Payment provider details.
Whether the config is deleted or not. true represents config is deleted
The creation timestamp of the custom provider.
The last update timestamp of the custom provider.
Trace id of the custom provider.
```json theme={null}
{
"name": "Company Paypal Integration",
"description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.",
"paymentsUrl": "https://testpayment.paypal.com",
"queryUrl": "https://testsubscription.paypal.com",
"imageUrl": "https://testsubscription.paypal.com",
"_id": "662a44ad19a2a44d3cd9d749",
"locationId": "Lk3nlfk4lxlelVEwcW",
"marketplaceAppId": "65f0b217a05c774da7f1efa5",
"paymentProvider": "{ live: { liveMode: true }, test: { liveMode: false, apiKey: \"y5ZQxryRFXZHvUJZdLXXXXXX\", publishableKey: \"rzp_test_zPRoVMLOa0A9wo\" }}",
"deleted": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"traceId": "302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/payments/custom-provider/provider' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "Company Paypal Integration",
"description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.",
"paymentsUrl": "https://testpayment.paypal.com",
"queryUrl": "https://testsubscription.paypal.com",
"imageUrl": "https://testsubscription.paypal.com",
"supportsSubscriptionSchedule": true
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/custom-provider/provider', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "Company Paypal Integration", "description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.", "paymentsUrl": "https://testpayment.paypal.com", "queryUrl": "https://testsubscription.paypal.com", "imageUrl": "https://testsubscription.paypal.com", "supportsSubscriptionSchedule": true}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/payments/custom-provider/provider',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "Company Paypal Integration", "description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.", "paymentsUrl": "https://testpayment.paypal.com", "queryUrl": "https://testsubscription.paypal.com", "imageUrl": "https://testsubscription.paypal.com", "supportsSubscriptionSchedule": true},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'Company Paypal Integration', 'description': 'This payment gateway supports payments in India via UPI, Net banking, cards and wallets.', 'paymentsUrl': 'https://testpayment.paypal.com', 'queryUrl': 'https://testsubscription.paypal.com', 'imageUrl': 'https://testsubscription.paypal.com', 'supportsSubscriptionSchedule': true}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create White-label Integration Provider
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-create-integration-provider
The "Create White-label Integration Provider" API allows adding a new payment provider integration to the system which is built on top of Authorize.net or NMI. Use this endpoint to create a integratio
The "Create White-label Integration Provider" API allows adding a new payment provider integration to the system which is built on top of Authorize.net or NMI. Use this endpoint to create a integration provider with the specified details. Ensure that the required information is provided in the request payload. This endpoint can be only invoked using marketplace-app token
```http theme={null}
POST https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
A unique name given to the integration provider, uniqueName must start and end with a character. Only lowercase characters and hyphens (-) are supported
The title or name of the integration provider.
The type of payment provider associated with the integration provider. Posibles valores: 'authorize-net', 'nmi'
A brief description providing additional information about the integration provider.
The URL to an image representing the integration provider. The imageUrl should start with "https\://" and ensure that this URL is publicly accessible.
## Respuestas
The unique identifier of the integration provider.
The altId / locationId of the integration provider.
The altType of the integration provider.
The title or name of the integration provider.
The route name associated with the integration provider.
The payment provider associated with the integration provider.
A brief description providing additional information about the integration provider.
The URL to an image representing the integration provider.
The timestamp when the integration provider was created.
The timestamp when the integration provider was last updated.
```json theme={null}
{
"_id": "65cb47dda50f4f13ced4b870",
"altId": "Z4Bxl8J4SaPEPLq9IQ8g",
"altType": "account",
"title": "Example",
"route": "epd",
"provider": "nmi",
"description": "Lorem",
"imageUrl": "https://example.com/assets/pmd/img/payments/nmi-logo.webp",
"createdAt": "2024-02-13T10:43:41.026Z",
"updatedAt": "2024-02-13T10:43:41.026Z"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"uniqueName": "easy-direct",
"title": "Title",
"provider": {
"AUTHORIZE_NET": "authorize-net",
"NMI": "nmi"
},
"description": "Description",
"imageUrl": "https://example.com/image.jpg"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "uniqueName": "easy-direct", "title": "Title", "provider": {"AUTHORIZE_NET": "authorize-net", "NMI": "nmi"}, "description": "Description", "imageUrl": "https://example.com/image.jpg"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "uniqueName": "easy-direct", "title": "Title", "provider": {"AUTHORIZE_NET": "authorize-net", "NMI": "nmi"}, "description": "Description", "imageUrl": "https://example.com/image.jpg"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'uniqueName': 'easy-direct', 'title': 'Title', 'provider': {'AUTHORIZE_NET': 'authorize-net', 'NMI': 'nmi'}, 'description': 'Description', 'imageUrl': 'https://example.com/image.jpg'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create order fulfillment
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-create-order-fulfillment
The "Order Fulfillment" API facilitates the process of fulfilling an order.
The "Order Fulfillment" API facilitates the process of fulfilling an order.
```http theme={null}
POST https://services.leadconnectorhq.com/payments/orders/{orderId}/fulfillments
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the order that needs to be returned
## Body
Account Id or Agency Id
Posibles valores: 'account'
Fulfillment tracking information
Tracking number provided by the shipping carrier
Shipping carrier name
Tracking URL
Fulfilled items
The id of product price
The no of quantity of the item
Need to send a notification to customer
## Respuestas
Status of api action
fulfillment data
```json theme={null}
{
"status": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/fulfillments' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"trackings": [
{
"trackingNumber": "40012345678",
"shippingCarrier": "FedEx",
"trackingUrl": "https://www.fedex.com/wtrk/track/?trknbr=40012345678"
}
],
"items": [
{
"priceId": "6578278e879ad2646715ba9c",
"qty": 1
}
],
"notifyCustomer": true
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/fulfillments', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "trackings": [{"trackingNumber": "40012345678", "shippingCarrier": "FedEx", "trackingUrl": "https://www.fedex.com/wtrk/track/?trknbr=40012345678"}], "items": [{"priceId": "6578278e879ad2646715ba9c", "qty": 1}], "notifyCustomer": true}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/fulfillments',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "trackings": [{"trackingNumber": "40012345678", "shippingCarrier": "FedEx", "trackingUrl": "https://www.fedex.com/wtrk/track/?trknbr=40012345678"}], "items": [{"priceId": "6578278e879ad2646715ba9c", "qty": 1}], "notifyCustomer": true},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'trackings': [{'trackingNumber': '40012345678', 'shippingCarrier': 'FedEx', 'trackingUrl': 'https://www.fedex.com/wtrk/track/?trknbr=40012345678'}], 'items': [{'priceId': '6578278e879ad2646715ba9c', 'qty': 1}], 'notifyCustomer': true}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Custom-provider marketplace app update capabilities
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-custom-provider-marketplace-app-update-capabilities
Toggle capabilities for the marketplace app tied to the OAuth client
Toggle capabilities for the marketplace app tied to the OAuth client
```http theme={null}
PUT https://services.leadconnectorhq.com/payments/custom-provider/capabilities
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Whether the marketplace app supports subscription schedules or not
Company id. Mandatory if locationId is not provided
Account / Account id. Mandatory if companyId is not provided
## Respuestas
Whether the custom provider capabilities are updated or not. true represents capabilities are updated
```json theme={null}
{
"success": "true"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/payments/custom-provider/capabilities' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"supportsSubscriptionSchedules": true,
"companyId": "Yjnwuduw83e8x30sm0",
"locationId": "Yjnwuduw83e8x30sm0"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/custom-provider/capabilities', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"supportsSubscriptionSchedules": true, "companyId": "Yjnwuduw83e8x30sm0", "locationId": "Yjnwuduw83e8x30sm0"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/payments/custom-provider/capabilities',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"supportsSubscriptionSchedules": true, "companyId": "Yjnwuduw83e8x30sm0", "locationId": "Yjnwuduw83e8x30sm0"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'supportsSubscriptionSchedules': true, 'companyId': 'Yjnwuduw83e8x30sm0', 'locationId': 'Yjnwuduw83e8x30sm0'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Coupon
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-delete-coupon
The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note tha
The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone.
```http theme={null}
DELETE https://services.leadconnectorhq.com/payments/coupon
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
Alt Type Posibles valores: 'account'
Coupon Id
## Respuestas
Indicates whether the delete was successful
Unique identifier for tracing this API request
```json theme={null}
{
"success": true,
"traceId": "c667b18d-8f5e-44cf-a914"
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/payments/coupon' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "BQdAwxa0ky1iK2sstLGJ",
"altType": "account",
"id": "6241712be68f7a98102ba272"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/coupon', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "id": "6241712be68f7a98102ba272"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/payments/coupon',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "id": "6241712be68f7a98102ba272"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': 'BQdAwxa0ky1iK2sstLGJ', 'altType': 'account', 'id': '6241712be68f7a98102ba272'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Deleting an existing integration
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-delete-integration
API to delete an association for an app and account
API to delete an association for an app and account
```http theme={null}
DELETE https://services.leadconnectorhq.com/payments/custom-provider/provider
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account id
## Respuestas
Whether the custom provider config is disconnect or not. true represents config is disconnect
```json theme={null}
{
"success": "true"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/payments/custom-provider/provider' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/custom-provider/provider', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/payments/custom-provider/provider',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Disconnect existing provider config
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-disconnect-config
API to disconnect an existing payment config for given account
API to disconnect an existing payment config for given account
```http theme={null}
POST https://services.leadconnectorhq.com/payments/custom-provider/disconnect
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account id
## Body
Whether the config is for test mode or live mode. true represents config is for live payments
## Respuestas
Whether the custom provider config is disconnect or not. true represents config is disconnect
```json theme={null}
{
"success": "true"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/payments/custom-provider/disconnect' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"liveMode": "true"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/custom-provider/disconnect', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"liveMode": "true"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/payments/custom-provider/disconnect',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"liveMode": "true"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'liveMode': 'true'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch given provider config
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-fetch-config
API for fetching an existing payment config for given account
API for fetching an existing payment config for given account
```http theme={null}
GET https://services.leadconnectorhq.com/payments/custom-provider/connect
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account id
## Respuestas
The name of the custom provider
Description of payment gateway. Shown on the payments integrations page as subtext
This url will be loaded in iFrame to start a payment session.
The url used for querying payments related events. Ex. verify, refund, subscription etc.
Public image url for logo of the payment gateway displayed on the payments integrations page.
The unique identifier for the custom provider.
Account id
The application id of marketplace
Payment provider details.
Whether the config is deleted or not. true represents config is deleted
The creation timestamp of the custom provider.
The last update timestamp of the custom provider.
Trace id of the custom provider.
```json theme={null}
{
"name": "Company Paypal Integration",
"description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.",
"paymentsUrl": "https://testpayment.paypal.com",
"queryUrl": "https://testsubscription.paypal.com",
"imageUrl": "https://testsubscription.paypal.com",
"_id": "662a44ad19a2a44d3cd9d749",
"locationId": "Lk3nlfk4lxlelVEwcW",
"marketplaceAppId": "65f0b217a05c774da7f1efa5",
"paymentProvider": "{ live: { liveMode: true }, test: { liveMode: false, apiKey: \"y5ZQxryRFXZHvUJZdLXXXXXX\", publishableKey: \"rzp_test_zPRoVMLOa0A9wo\" }}",
"deleted": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"traceId": "302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/custom-provider/connect' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/custom-provider/connect', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/custom-provider/connect',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch Coupon
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-get-coupon
The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon paramete
The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods, and other promotional details.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/coupon
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id
Alt Type
Coupon id
Coupon code
## Respuestas
Unique MongoDB identifier for the coupon
Number of times the coupon has been used
Maximum number of times a customer can use this coupon (0 for unlimited)
Account Id
Type of entity
Display name of the coupon
Redemption code for the coupon
Type of discount (percentage or amount) Posibles valores: 'percentage', 'amount'
Value of the discount (percentage or fixed amount)
Current status of the coupon Posibles valores: 'scheduled', 'active', 'expired'
Date when the coupon becomes active
End date when the coupon expires
Indicates if the coupon applies to future recurring payments
Configuration for how the coupon applies to future payments
User ID associated with the coupon (if applicable)
Creation timestamp
Last update timestamp
Unique identifier for tracing this API request
```json theme={null}
{
"_id": "67f6c132d9485f9dacd5f123",
"usageCount": 12,
"limitPerCustomer": 5,
"altId": "79t07PzK8Tvf73d12312",
"altType": "account",
"name": "NEWT6",
"code": "NEWT6",
"discountType": "percentage",
"discountValue": 25,
"status": "scheduled",
"startDate": "2025-04-30T18:30:00.000Z",
"endDate": "2025-05-30T18:30:00.000Z",
"applyToFuturePayments": true,
"userId": "q0m15dTLGeiGOXG123123",
"createdAt": "2025-04-09T18:49:22.026Z",
"updatedAt": "2025-04-09T18:49:22.026Z",
"traceId": "c667b18d-8f5e-44cf-a914"
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/coupon' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/coupon', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/coupon',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Order by ID
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-get-order-by-id
The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID.
The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/orders/{orderId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the order that needs to be returned
## Query parameters
LocationId is the id of the account.
AltId is the unique identifier e.g: account id.
## Respuestas
The unique identifier for the order.
AltId is the unique identifier eg: account id.
AltType is the type of identifier.
Contact id corresponding to the order.
Currency in which order was created.
Order value.
The status of the order (e.g., completed).
Order is in live / test mode.
The creation timestamp of the order.
The last update timestamp of the order.
Fulfillment status of the order.
Contact details of the order.
Amount details of the order.
Source details of the order.
Item details of the order.
Coupon details of the order.
Tracking id of the order.
Fingerprint id of the order.
Meta details of the order.
Is test order.
Trace id of the order.
Automatic taxes applied for the Order
Provider name for automatic tax calculation
User ID who created the order.
```json theme={null}
{
"_id": "653f5e0cde5a1314e62a837c",
"altId": "3SwdhCu3svxI8AKsPJt6",
"altType": "account",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"currency": "USD",
"amount": "100",
"status": "completed",
"liveMode": "false",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"fulfillmentStatus": "unfulfilled",
"contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@leadwaycrm.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
"amountSummary": "{ subtotal: 100, discount: 5 }",
"source": "{ type: \"invoice\", id: \"61dd48ff65b013bc39bb09c6\" }",
"items": "{ _id: 61dd33e88058b9f967ca79dc, authorizeAmount: 0, locationId: \"SBAWb4yu7A4LSc0skQ6g\", name: \"Sample Product\": price: {}, product: { name: \"Testing product\", productType: \"SERVICE\" }}",
"coupon": "{ code: \"FEST10\", _id: \"63455e48901b43d4ef364a20\" }",
"trackingId": "63319ef9-de0a-4c84-aebd-3585fb4a0cdf",
"fingerprint": "5d51db5a-42b0-4b04-ba88-2c046c982a3a",
"meta": "{ couponSessionExpired: true }",
"markAsTest": "false",
"traceId": "d3b16a92-a8ed-4e6b-8467-844750f78ed5",
"automaticTaxesCalculated": true,
"taxCalculationProvider": "taxjar",
"createdBy": "user123"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/orders/YOUR_orderId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Subscription by ID
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-get-subscription-by-id
The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provi
The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provided subscription ID.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/subscriptions/{subscriptionId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the subscription that needs to be returned
## Query parameters
AltId is the unique identifier e.g: account id.
AltType is the type of identifier.
## Respuestas
The unique identifier for the subscription.
AltType is the type of identifier.
AltId is the unique identifier eg: account id.
Contact id corresponding to the subscription.
Contact details of the subscriber.
Coupon details of the subscription.
Currency in which subscription was made.
Subscription value.
Subscription status.
Subscription is in live / test mode.
Entity type of subscription (eg: order).
Entity id for the subscription. e.g: order id
Entity source details for the subscription.
Subscription id for subscription.
Snapshot of subscription.
Payment provider details for the subscription.
Ip address from where subscription was initiated.
The creation timestamp of the subscription.
The last update timestamp of the subscription.
Meta details of the subscription.
Is test subscription.
Scedule details for the subscription.
Auto payment details of the subscription.
Recurring product details of the subscription.
Cancellation timestamp of the subscription.
User id who cancelled the subscription.
Trace id of the subscription.
User ID who created the subscription.
```json theme={null}
{
"_id": "64bf78af39118e4011926cba",
"altType": "account",
"altId": "3SwdhCu3svxI8AKsPJt6",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@leadwaycrm.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
"coupon": "{ _id: \"6374c6926d119a393fe1e556\", usageCount: 5260, altId: \"jVFIxsMY19D94nOSIOEO\", altType: \"account\", name: \"FREE-100%\", code: \"FREE100\", discountType: \"percentage\", discountValue: 100 }",
"currency": "USD",
"amount": "100",
"status": "active",
"liveMode": "false",
"entityType": "order",
"entityId": "62f4db0f3059ecee61379012",
"entitySource": "{ type: \"funnel\", id: \"lx6ROqruHGVQD2PZwFxK\", subType: \"upsell\", name: \"test funnel\" }",
"subscriptionId": "I-0UE609H8E43P",
"subscriptionSnapshot": "{ status: \"ACTIVE\", status_update_time: \"2022-08-16T11:06:53Z\", id: \"I-0UE609H8E43P\", plan_id: \"P-82K11750F0313430KMLRGE6Y\", start_time: \"2022-08-16T11:05:31Z\", quantity: 1 }",
"paymentProvider": "{ type: \"paypal\", connectedAccount: { _id: \"64410debdc8f3b0503523abb\", merchantClientId: \"AeXtjrxdgsJiCPwQt5jML5pH-0mwmLs-tH7ub4Uo3IrDKvRl34FvJy8niI6E1wmS_pryIRdNllyVl58b\" } }",
"ipAddress": "103.100.16.82",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"meta": "{ collection: \"transactionsv2\", id: \"6320652f0f664b6632006920\" }",
"markAsTest": "false",
"schedule": "{ collection: \"transactionsv2\", id: \"6320652f0f664b6632006920\" }",
"autoPayment": "{ customerId: \"908879612\", paymentMethodId: \"908646635\" }",
"recurringProduct": "{ locationId: \"Z4Bxl8J4SaPEPLq9IQ8g\", funnel: \"bQHJWKcyjiKjk4BHv91g\", step: \"2281a993-8a75-4b48-9912-571f29c99a74\", name: \"Sofa Set\" }",
"canceledAt": "2023-11-20T10:23:36.515Z",
"canceledBy": "qUuXUiB2AiA2DIthEicP",
"traceId": "302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a",
"createdBy": "user123"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/subscriptions/YOUR_subscriptionId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/subscriptions/YOUR_subscriptionId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/subscriptions/YOUR_subscriptionId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Transaction by ID
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-get-transaction-by-id
The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for a single transaction based on the provided
The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for a single transaction based on the provided transaction ID.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/transactions/{transactionId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the transaction that needs to be returned
## Query parameters
LocationId is the id of the account.
AltId is the unique identifier e.g: account id.
AltType is the type of identifier.
## Respuestas
The unique identifier for the transaction.
AltType is the type of identifier.
AltId is the unique identifier eg: account id.
Contact id corresponding to the transaction.
Contact details of the transaction.
Currency in which transaction was made.
Transaction value.
Transaction status.
Transaction is in live / test mode.
The creation timestamp of the transaction.
The last update timestamp of the transaction.
Entity type of transaction (eg: order).
Entity id for the transaction. e.g: order id
Entity source details for the transaction.
Charge id for transaction.
Charge snapshot of transaction.
Invoice id for the transaction.
Subscription id for transaction.
Payment provider details of the transaction.
Ip address from where transaction was initiated.
Meta details of the transaction.
Is test transaction.
Is parent transaction.
Transaction amount refunded.
Receipt id for transaction.
Is transaction qbo synced.
Qbo details of the transaction.
Trace id of the transaction.
ID of the contact that was merged from.
User ID who created the transaction.
```json theme={null}
{
"_id": "61dd0feac077f72010f78804",
"altType": "account",
"altId": "3SwdhCu3svxI8AKsPJt6",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@leadwaycrm.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
"currency": "USD",
"amount": "100",
"status": "succeeded",
"liveMode": "false",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"entityType": "order",
"entityId": "61dd0fe9c077f73e67f78803",
"entitySource": "{ type: \"funnel\", id: \"BDBMEghdIUaqMPEsK349\", subType: \"two_step_order_form\", name: \"new funnel\" }",
"chargeId": "in_1KGcXDCScnf89tZohCsmImwE",
"chargeSnapshot": "{ id: \"in_1KGcXDCScnf89tZohCsmImwE\", object: \"invoice\", account_country: \"US\", account_name: \"GHL-Testing\" }",
"invoiceId": "in_1KGcXDCScnf89tZohCsmImwE",
"subscriptionId": "sub_1KGcXDCScnf89tZoVkoEMCEL",
"paymentProvider": "{ type: \"stripe\", connectedAccount: { _id: \"612ca676b484b241fef9d962\", accountId: \"acct_1Ihw53CScnf89tZo\" } }",
"ipAddress": "107.178.194.224",
"meta": "{ stepId: \"af7c731e-e36f-4152-bd1a-3f69a31d6d6d\", pageId: \"A8ltotc2jZxurJba4e3Y\", pageUrl: \"/v2/preview/A8ltotc2jZxurJba4e3Y\" }",
"markAsTest": "false",
"isParent": "false",
"amountRefunded": "10",
"receiptId": "6492fbea489bc07892c6defb",
"qboSynced": "false",
"qboResponse": "{ domain: \"QBO\", sparse: false, Id: \"180\", SyncToken: \"0\", TotalAmt: 25 }",
"traceId": "d3b16a92-a8ed-4e6b-8467-844750f78ed5",
"mergedFromContactId": "XPLSw2SVagl12LMDeTmQ",
"createdBy": "user123"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/transactions/YOUR_transactionId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/transactions/YOUR_transactionId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/transactions/YOUR_transactionId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Coupons
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-list-coupons
The "List Coupons" API allows you to retrieve a list of all coupons available in your account. Use this endpoint to view all promotional offers and special discounts for your customers.
The "List Coupons" API allows you to retrieve a list of all coupons available in your account. Use this endpoint to view all promotional offers and special discounts for your customers.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/coupon/list
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id
Alt Type
Maximum number of coupons to return
Number of coupons to skip for pagination
Filter coupons by status
Search term to filter coupons by name or code
## Respuestas
Array of coupon objects
Unique MongoDB identifier for the coupon
Number of times the coupon has been used
Maximum number of times a customer can use this coupon (0 for unlimited)
Account Id
Type of entity
Display name of the coupon
Redemption code for the coupon
Type of discount (percentage or amount) Posibles valores: 'percentage', 'amount'
Value of the discount (percentage or fixed amount)
Current status of the coupon Posibles valores: 'scheduled', 'active', 'expired'
Date when the coupon becomes active
End date when the coupon expires
Indicates if the coupon applies to future recurring payments
Configuration for how the coupon applies to future payments
User ID associated with the coupon (if applicable)
Creation timestamp
Last update timestamp
Total number of coupons matching the query criteria
Unique identifier for tracing this API request
```json theme={null}
{
"data": [
{
"_id": "67f6c132d9485f9dacd5f123",
"usageCount": 12,
"limitPerCustomer": 5,
"altId": "79t07PzK8Tvf73d12312",
"altType": "account",
"name": "NEWT6",
"code": "NEWT6",
"discountType": "percentage",
"discountValue": 25,
"status": "scheduled",
"startDate": "2025-04-30T18:30:00.000Z",
"endDate": "2025-05-30T18:30:00.000Z",
"applyToFuturePayments": true,
"userId": "q0m15dTLGeiGOXG123123",
"createdAt": "2025-04-09T18:49:22.026Z",
"updatedAt": "2025-04-09T18:49:22.026Z"
}
],
"totalCount": 20,
"traceId": "c667b18d-8f5e-44cf-a914"
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/coupon/list' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/coupon/list', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/coupon/list',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List White-label Integration Providers
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-list-integration-providers
The "List White-label Integration Providers" API allows to retrieve a paginated list of integration providers. Customize your results by filtering whitelabel integration providers(which are built dire
The "List White-label Integration Providers" API allows to retrieve a paginated list of integration providers. Customize your results by filtering whitelabel integration providers(which are built directly on top of Authorize.net or NMI) based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve integration provider information.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
account Id / company Id based on altType
Alt Type
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
## Respuestas
list of integration provider.
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List fulfillment
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-list-order-fulfillment
List all fulfillment history of an order
List all fulfillment history of an order
```http theme={null}
GET https://services.leadconnectorhq.com/payments/orders/{orderId}/fulfillments
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the order that needs to be returned
## Query parameters
Account Id or Agency Id
## Respuestas
Status of api action
An array of fulfilled items
Account Id or Agency Id
Posibles valores: 'account'
Fulfillment tracking information
Tracking number provided by the shipping carrier
Shipping carrier name
Tracking URL
The unique identifier for the fulfillment item.
Fulfilled items
The id of product price
Name
Product details
Price details
The no of quantity of the current fulfilled item
created at
updated at
```json theme={null}
{
"status": true,
"data": [
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"trackings": [
{}
],
"_id": "655b33a82209e60b6adb87a5",
"items": [
{}
],
"createdAt": "2023-12-12T09:27:42.355Z",
"updatedAt": "2023-12-12T09:27:42.355Z"
}
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/fulfillments' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/fulfillments', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/fulfillments',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Order Notes
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-list-order-notes
List all notes of an order
List all notes of an order
```http theme={null}
GET https://services.leadconnectorhq.com/payments/orders/{orderId}/notes
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the order that needs to be returned
## Query parameters
Account Id or Agency Id
## Respuestas
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/notes' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/notes', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/notes',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Orders
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-list-orders
The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact
The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/orders
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
LocationId is the id of the account.
AltId is the unique identifier e.g: account id.
Order status.
Payment Status of the Order
Mode of payment.
Starting interval of orders.
Closing interval of orders.
The name of the order for searching.
Contact id for filtering of orders.
Funnel product ids separated by comma.
Source id
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
## Respuestas
An array of orders
The unique identifier for the order.
AltId is the unique identifier eg: account id.
AltType is the type of identifier.
Contact id corresponding to the order.
Contact name corresponding to the order.
Contact email corresponding to the order.
Currency in which order was created.
Order value.
Order sub-total value.
Discount value on order.
The status of the order (e.g., completed).
Order is in live / test mode.
Total products in an order.
Source type of order (eg: funnel).
Source name for the order.
Source id for the order.
Meta content for the source of order.
Coupon code for the order.
The creation timestamp of the order.
The last update timestamp of the order.
Source sub-type for the order.
Fulfillment status of the order.
Total one time products in an order.
Total recurring time products in an order.
User ID who created the order.
total orders count
```json theme={null}
{
"data": [
{
"_id": "653f5e0cde5a1314e62a837c",
"altId": "3SwdhCu3svxI8AKsPJt6",
"altType": "account",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"contactName": "James Bond",
"contactEmail": "james.bond@leadwaycrm.com",
"currency": "USD",
"amount": "100",
"subtotal": "100",
"discount": "10",
"status": "completed",
"liveMode": "false",
"totalProducts": "5",
"sourceType": "funnel",
"sourceName": "onestep",
"sourceId": "kDj7BHej9Zyyq3QakJmz",
"sourceMeta": "{ domain: \"app.leadwaycrm.com\", pageId: \"rBVhyYhMsbxbO8ZqOcei\", pageUrl: \"/v2/preview/rBVhyYhMsbxbO8ZqOcei\", stepId: \"5a772f62-3fbc-418b-af1b-be8929dd64c2\"}",
"couponCode": "100PER",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"sourceSubType": "one_step_order_form",
"fulfillmentStatus": "unfulfilled",
"onetimeProducts": "1",
"recurringProducts": "1",
"createdBy": "user123"
}
],
"totalCount": 0
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/orders' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/orders', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/orders',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Subscriptions
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-list-subscriptions
The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date ra
The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date range, type of source, contact, subscription id, entity id, contact or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve subscription information.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/subscriptions
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
AltId is the unique identifier e.g: account id.
AltType is the type of identifier.
Entity id for filtering of subscriptions.
Mode of payment.
Starting interval of subscriptions.
Closing interval of subscriptions.
Source of the subscriptions.
The name of the subscription for searching.
Contact ID for the subscription
Subscription id for filtering of subscriptions.
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
Get the total payments collected for the subscription.
## Respuestas
An array of subscriptions
The unique identifier for the subscription.
AltId is the unique identifier eg: account id.
AltType is the type of identifier. Posibles valores: 'account'
Contact id corresponding to the subscription.
Contact name corresponding to the subscription.
Contact email corresponding to the subscription.
Currency in which subscription occurred.
Subscription value.
The status of the subscription (e.g., succeeded).
Subscription is in live / test mode.
Entity type of subscription (eg: order).
Entity id for the subscription. e.g: order id
Entity source type of subscription (eg: funnel).
Entity source name for the subscription.
Entity source id for the subscription.
Meta content for the entity source of subscription.
Subscription id for subscription.
Snapshot of subscription.
Payment provider for subscription.
Payment provider connected account id for subscription.
Ip address from where subscription was initiated.
The creation timestamp of the subscription.
The update timestamp of the subscription.
User ID who created the subscription.
total subscriptions count
```json theme={null}
{
"data": [
{
"_id": "64bf78af39118e4011926cba",
"altId": "3SwdhCu3svxI8AKsPJt6",
"altType": "account",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"contactName": "James Bond",
"contactEmail": "james.bond@leadwaycrm.com",
"currency": "USD",
"amount": "100",
"status": "active",
"liveMode": "false",
"entityType": "order",
"entityId": "62f4db0f3059ecee61379012",
"entitySourceType": "funnel",
"entitySourceName": "Attribution Funnel",
"entitySourceId": "bevrkPbLaDNXFaqfLKMm",
"entitySourceMeta": "{ domain: \"app.leadwaycrm.com\", pageId: \"sxC4lNhFIavEnLZh5KhC\", pageUrl: \"/v2/preview/sxC4lNhFIavEnLZh5KhC\", stepId: \"7d303d1f-cb85-403d-b548-bf01de5c7bb0\" }",
"subscriptionId": "I-0UE609H8E43P",
"subscriptionSnapshot": "{ status: \"ACTIVE\", status_update_time: \"2022-08-16T11:06:53Z\", id: \"I-0UE609H8E43P\", plan_id: \"P-82K11750F0313430KMLRGE6Y\", start_time: \"2022-08-16T11:05:31Z\", quantity: 1 }",
"paymentProviderType": "stripe",
"paymentProviderConnectedAccount": "ATn0CqrzrWS5ak185Bsb1xCpyzBDOZ8WdRxyFotppLYePTDhiuQ49H5QXO_L-4HKk1GBn7f9_QhbNK2s",
"ipAddress": "103.100.16.82",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2023-11-20T10:23:36.515Z",
"createdBy": "user123"
}
],
"totalCount": 0
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/subscriptions' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/subscriptions', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/subscriptions',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Transactions
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-list-transactions
The "List Transactions" API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range,
The "List Transactions" API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range, type of source, contact, subscription id, entity id or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve transaction information.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/transactions
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
LocationId is the id of the account.
AltId is the unique identifier e.g: account id.
AltType is the type of identifier.
Mode of payment.
Starting interval of transactions.
Closing interval of transactions.
Source of the transactions.
Source sub-type of the transactions.
The name of the transaction for searching.
Subscription id for filtering of transactions.
Entity id for filtering of transactions.
Contact id for filtering of transactions.
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
## Respuestas
An array of transactions
The unique identifier for the transaction.
AltId is the unique identifier eg: account id.
AltType is the type of identifier.
Contact id corresponding to the transaction.
ID of the contact that was merged from.
Contact name corresponding to the transaction.
Contact email corresponding to the transaction.
Currency in which transaction occurred.
Transaction value.
The status of the transaction (e.g., succeeded).
Transaction is in live / test mode.
Entity type of transaction (eg: order).
Entity id for the transaction. e.g: order id
Entity source type of transaction (eg: funnel).
Entity source sub-type of the transactions.
Entity source name for the transaction.
Entity source id for the transaction.
Meta content for the entity source of transaction.
Subscription id for transaction.
Charge id for transaction.
Charge snapshot of transaction.
Payment provider for transaction.
Payment provider account id for transaction.
Ip address from where transaction was initiated.
The creation timestamp of the transaction.
The update timestamp of the transaction.
Transaction amount refunded.
Transaction payment method details.
The charged timestamp of the transaction.
User ID who created the transaction.
total transactions count
```json theme={null}
{
"data": [
{
"_id": "61dd0feac077f72010f78804",
"altId": "3SwdhCu3svxI8AKsPJt6",
"altType": "account",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"mergedFromContactId": "XPLSw2SVagl12LMDeTmQ",
"contactName": "James Bond",
"contactEmail": "james.bond@leadwaycrm.com",
"currency": "USD",
"amount": "100",
"status": "succeeded",
"liveMode": "false",
"entityType": "order",
"entityId": "61dd0fe9c077f73e67f78803",
"entitySourceType": "funnel",
"entitySourceSubType": "two_step_order_form",
"entitySourceName": "new funnel",
"entitySourceId": "BDBMEghdIUaqMPEsK349",
"entitySourceMeta": "{ domain: \"app.leadwaycrm.com\", pageId: \"rBVhyYhMsbxbO8ZqOcei\", pageUrl: \"/v2/preview/rBVhyYhMsbxbO8ZqOcei\", stepId: \"5a772f62-3fbc-418b-af1b-be8929dd64c2\"}",
"subscriptionId": "sub_1KGcXDCScnf89tZoVkoEMCEL",
"chargeId": "in_1KGcXDCScnf89tZohCsmImwE",
"chargeSnapshot": "{ id: \"in_1KGcXDCScnf89tZohCsmImwE\", object: \"invoice\", account_country: \"US\", account_name: \"GHL-Testing\" }",
"paymentProviderType": "stripe",
"paymentProviderConnectedAccount": "612ca676b484b241fef9d962",
"ipAddress": "107.178.194.224",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2023-11-20T10:23:36.515Z",
"amountRefunded": "10",
"paymentMethod": "{ card: { \"brand\": \"discover\", \"last4\": \"0012\" } }",
"fulfilledAt": "2023-11-20T10:27:36.515Z",
"createdBy": "user123"
}
],
"totalCount": 0
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/transactions' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/transactions', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/transactions',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Record Order Payment
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-record-order-payment
The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid".
The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid".
```http theme={null}
POST https://services.leadconnectorhq.com/payments/orders/{orderId}/record-payment
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Order ID
## Body
account Id / company Id based on altType
Alt Type Posibles valores: 'account'
manual payment method Posibles valores: 'cash', 'card', 'cheque', 'bank\_transfer', 'other'
Details of Card if used for payment
Details of the Cheque if used for payment
Any note to be recorded with the transaction
Amount to be paid against the invoice.
Meta data to be recorded with the transaction
Indicates if the order is intended to be a partial payment.
## Respuestas
Success status of the request
```json theme={null}
{
"success": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/record-payment' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"mode": "card",
"notes": "This was a direct payment",
"amount": 100,
"meta": {},
"isPartialPayment": true
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/record-payment', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "mode": "card", "notes": "This was a direct payment", "amount": 100, "meta": {}, "isPartialPayment": true}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/record-payment',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "mode": "card", "notes": "This was a direct payment", "amount": 100, "meta": {}, "isPartialPayment": true},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'mode': 'card', 'notes': 'This was a direct payment', 'amount': 100, 'meta': {}, 'isPartialPayment': true}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Coupon
Source: https://developers.leadwaycrm.com/api-reference/payments/payments-update-coupon
The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters. Use this endpoint to adjust or extend p
The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters. Use this endpoint to adjust or extend promotional offers for your customers.
```http theme={null}
PUT https://services.leadconnectorhq.com/payments/coupon
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
Alt Type Posibles valores: 'account'
Coupon Name
Coupon Code
Discount Type Posibles valores: 'percentage', 'amount'
Discount Value
Start date in YYYY-MM-DDTHH:mm:ssZ format
End date in YYYY-MM-DDTHH:mm:ssZ format
Max number of times coupon can be used
Product Ids
Is Coupon applicable on upcoming subscription transactions
If coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription
Limits whether a coupon can be redeemed only once per customer.
Coupon Id
## Respuestas
Unique MongoDB identifier for the coupon
Number of times the coupon has been used
Maximum number of times a customer can use this coupon (0 for unlimited)
Account Id
Type of entity
Display name of the coupon
Redemption code for the coupon
Type of discount (percentage or amount) Posibles valores: 'percentage', 'amount'
Value of the discount (percentage or fixed amount)
Current status of the coupon Posibles valores: 'scheduled', 'active', 'expired'
Date when the coupon becomes active
End date when the coupon expires
Indicates if the coupon applies to future recurring payments
Configuration for how the coupon applies to future payments
User ID associated with the coupon (if applicable)
Creation timestamp
Last update timestamp
Unique identifier for tracing this API request
```json theme={null}
{
"_id": "67f6c132d9485f9dacd5f123",
"usageCount": 12,
"limitPerCustomer": 5,
"altId": "79t07PzK8Tvf73d12312",
"altType": "account",
"name": "NEWT6",
"code": "NEWT6",
"discountType": "percentage",
"discountValue": 25,
"status": "scheduled",
"startDate": "2025-04-30T18:30:00.000Z",
"endDate": "2025-05-30T18:30:00.000Z",
"applyToFuturePayments": true,
"userId": "q0m15dTLGeiGOXG123123",
"createdAt": "2025-04-09T18:49:22.026Z",
"updatedAt": "2025-04-09T18:49:22.026Z",
"traceId": "c667b18d-8f5e-44cf-a914"
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/payments/coupon' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "BQdAwxa0ky1iK2sstLGJ",
"altType": "account",
"name": "New Year Sale",
"code": "LEVELUPDAY2022",
"discountType": "amount",
"discountValue": 10,
"startDate": "2023-01-01T22:45:00.000Z",
"endDate": "2023-01-31T22:45:00.000Z",
"usageLimit": 10,
"productIds": [
"6241712be68f7a98102ba272"
],
"applyToFuturePayments": true,
"applyToFuturePaymentsConfig": [
{
"type": "fixed",
"duration": 5,
"durationType": "months"
},
{
"type": "forever"
}
],
"limitPerCustomer": true,
"id": "6241712be68f7a98102ba272"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/coupon', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "name": "New Year Sale", "code": "LEVELUPDAY2022", "discountType": "amount", "discountValue": 10, "startDate": "2023-01-01T22:45:00.000Z", "endDate": "2023-01-31T22:45:00.000Z", "usageLimit": 10, "productIds": ["6241712be68f7a98102ba272"], "applyToFuturePayments": true, "applyToFuturePaymentsConfig": [{"type": "fixed", "duration": 5, "durationType": "months"}, {"type": "forever"}], "limitPerCustomer": true, "id": "6241712be68f7a98102ba272"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/payments/coupon',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "name": "New Year Sale", "code": "LEVELUPDAY2022", "discountType": "amount", "discountValue": 10, "startDate": "2023-01-01T22:45:00.000Z", "endDate": "2023-01-31T22:45:00.000Z", "usageLimit": 10, "productIds": ["6241712be68f7a98102ba272"], "applyToFuturePayments": true, "applyToFuturePaymentsConfig": [{"type": "fixed", "duration": 5, "durationType": "months"}, {"type": "forever"}], "limitPerCustomer": true, "id": "6241712be68f7a98102ba272"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': 'BQdAwxa0ky1iK2sstLGJ', 'altType': 'account', 'name': 'New Year Sale', 'code': 'LEVELUPDAY2022', 'discountType': 'amount', 'discountValue': 10, 'startDate': '2023-01-01T22:45:00.000Z', 'endDate': '2023-01-31T22:45:00.000Z', 'usageLimit': 10, 'productIds': ['6241712be68f7a98102ba272'], 'applyToFuturePayments': true, 'applyToFuturePaymentsConfig': [{'type': 'fixed', 'duration': 5, 'durationType': 'months'}, {'type': 'forever'}], 'limitPerCustomer': true, 'id': '6241712be68f7a98102ba272'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# List active numbers
Source: https://developers.leadwaycrm.com/api-reference/phone-system/phone-system-active-numbers
Retrieve a paginated list of active phone numbers for a specific account. Supports filtering, pagination, and optional exclusion of number pool assignments.
Retrieve a paginated list of active phone numbers for a specific account. Supports filtering, pagination, and optional exclusion of number pool assignments.
```http theme={null}
GET https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
The unique identifier of the account
## Query parameters
How many resources to return in each list page. The default is 50, and the maximum is 1000.
The page index for pagination. The default is 0.
Filter numbers by phone number pattern. Supports partial matching (e.g., "+91" to find all Indian numbers).
Whether to exclude numbers that are assigned to number pools. Default is true.
## Respuestas
Array of phone number objects with detailed configuration
E.164 formatted phone number
Human-readable name assigned to the number
Phone number SID (unique identifier)
ISO 3166-1 alpha-2 country code
Communication capabilities supported by this number
Whether the number supports voice calls
Whether the number supports SMS messaging
Whether the number supports MMS messaging
Whether the number supports fax transmission
Type of phone number (local, toll-free, mobile, etc.) Posibles valores: 'local', 'toll-free', 'mobile', 'national'
Whether this is the default outbound number for the account
User ID of the user assigned to this number
Array of user IDs that should ring when this number is called
Configuration for inbound call handling service
Type of inbound call service Posibles valores: 'voice\_ai', 'ivr', 'forward'
Service configuration value or ID
Phone number to forward calls to
Whether group conversations are enabled for this number (US/CA numbers with SMS/MMS only)
Address SID for compliance purposes
Bundle SID for regulatory compliance
When the number was originally purchased/added
When the number configuration was last updated
Source or origin of the phone number Posibles valores: 'twilio', 'hosted', 'ported'
Whether this account is manged by LeadconnectorHQ
Number of items requested per page
Current page index (0-based)
Current status of the account Posibles valores: 'active', 'suspended', 'closed'
```json theme={null}
{
"numbers": [
{
"phoneNumber": "+14155552671",
"friendlyName": "Sales Line 1",
"sid": "PN1234567890abcdef1234567890abcde",
"countryCode": "US",
"capabilities": {
"voice": true,
"sms": true,
"mms": true,
"fax": false
},
"type": "local",
"isDefaultNumber": true,
"linkedUser": "user_123456789",
"linkedRingAllUsers": [
"user_123",
"user_456"
],
"inboundCallService": {
"type": "voice_ai",
"value": "68e381b296a83800a27cd1"
},
"forwardingNumber": "+14155552672",
"isGroupConversationEnabled": true,
"addressSid": "AD1234567890abcdef1234567890abcde",
"bundleSid": "BU1234567890abcdef1234567890abcde",
"dateAdded": "2023-01-15T10:30:00Z",
"dateUpdated": "2023-02-20T14:45:00Z",
"origin": "twilio"
},
{
"phoneNumber": "+18005551234",
"friendlyName": "Support Toll-Free",
"sid": "PN9876543210fedcba9876543210fedcb",
"countryCode": "US",
"capabilities": {
"voice": true,
// truncado: 26 lineas mas
}
```
```json theme={null}
{
"message": "Invalid locationId format or pagination parameters",
"error": "Bad Request",
"statusCode": 400
}
```
```json theme={null}
{}
```
```json theme={null}
{
"message": "Phone system is not connected to this account",
"statusCode": 404
}
```
Account status when error occurs
```json theme={null}
{
"msg": "Internal server error",
"accountStatus": "suspended"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List available phone numbers
Source: https://developers.leadwaycrm.com/api-reference/phone-system/phone-system-available-numbers
Search for available phone numbers to purchase for a specific account. Supports filtering by number pattern, type, and capabilities.
Search for available phone numbers to purchase for a specific account. Supports filtering by number pattern, type, and capabilities.
```http theme={null}
GET https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}/available
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
The unique identifier of the account
## Query parameters
ISO 3166-1 alpha-2 country code for which to search available numbers
Comma-separated list of phone number types to search for (e.g. local, tollFree, mobile)
Filter numbers that begin with this digit pattern
Filter numbers that end with this digit pattern
Filter numbers that contain this digit pattern anywhere
Filter for numbers with SMS capability
Filter for numbers with MMS capability
Filter for numbers with voice capability
## Respuestas
Unique fingerprint ID for this search result, required when purchasing one of the returned numbers
List of available phone numbers matching the search criteria
E.164 formatted phone number
Human-readable formatted phone number
ISO 3166-1 alpha-2 country code
Local Access and Transport Area code
City or locality of the number
Rate center of the number
Latitude coordinate of the number's account
Longitude coordinate of the number's account
State or region abbreviation
Postal code of the number
Address requirements for purchasing this number Posibles valores: 'none', 'any', 'local', 'foreign'
Whether this is a beta number
Communication capabilities supported by this number
Pricing information for this number
Type of number for billing purposes
Monthly price for this number
Currency unit for the price
```json theme={null}
{
"fingerprintId": "1773314252953",
"numbers": [
{
"phoneNumber": "+18705871861",
"friendlyName": "(870) 587-1861",
"lata": "528",
"locality": "Wynne",
"rateCenter": "WYNNE",
"latitude": "35.241800",
"longitude": "-90.846000",
"region": "AR",
"postalCode": "72396",
"isoCountry": "US",
"addressRequirements": "none",
"beta": false,
"capabilities": {
"MMS": true,
"SMS": true,
"voice": true
},
"price": {
"number_type": "local",
"price": 1.15,
"price_unit": "USD"
}
}
]
}
```
```json theme={null}
{
"message": "countryCode is required",
"error": "Bad Request",
"statusCode": 400
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Number Pools
Source: https://developers.leadwaycrm.com/api-reference/phone-system/phone-system-getnumberpoollist
Get list of number pools
Get list of number pools
```http theme={null}
GET https://services.leadconnectorhq.com/phone-system/number-pools
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account ID to filter pools
## Respuestas
Indicates if the request was successful
Array of number pool objects
Unique identifier for the number pool
Human-readable name of the number pool
Account ID this pool belongs to
Phone numbers in this pool
E.164 formatted phone number
Human-readable name for the number
Number to forward calls to
Whether whisper is enabled
Message played during whisper
Whether call recording is enabled
Whether the number pool is active
Inbound call service configuration
Type of inbound call service
Service configuration value/ID
Total number of pools returned
```json theme={null}
{
"success": true,
"data": [
{
"id": "ve9EPM428h8vShlRW1KT",
"name": "Sales Team Pool",
"locationId": "loc123",
"numbers": [
{
"phoneNumber": "+14155552671",
"friendlyName": "Sales Line 1"
}
],
"forwardingNumber": "+14155552671",
"whisper": true,
"whisperMessage": "Incoming call from sales line",
"callRecording": true,
"isActive": true,
"inboundCallService": {
"type": "voice_ai",
"value": "68e381b296a83800a27cd1"
}
}
],
"total": 1
}
```
```json theme={null}
{
"message": "Invalid locationId format",
"error": "Bad Request",
"statusCode": 400
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/phone-system/number-pools' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/phone-system/number-pools', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/phone-system/number-pools',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Purchase a phone number
Source: https://developers.leadwaycrm.com/api-reference/phone-system/phone-system-purchase-phone-number
Purchase a phone number for a specific account.
Purchase a phone number for a specific account.
```http theme={null}
POST https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}/purchase
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
The unique identifier of the account
## Body
The phone number to purchase
ISO 3166-1 alpha-2 country code of the number
Type of phone number Posibles valores: 'local', 'tollFree', 'mobile'
Twilio address SID for compliance
Twilio bundle SID for regulatory compliance
Locality where the number is being purchased
Region where the number is being purchased
Unique request ID for idempotency (fingerprint of the purchase request)
Skip account-level KYC verification if agency-level compliance has already been verified
## Respuestas
Unique identifier of the Twilio account record
Twilio Account SID
Whether this account is under a GHL-managed Twilio account
Whether SMS validation is enabled
The account ID this Twilio account belongs to
Current migration status of the account
List of numbers being migrated
Map of phone numbers to assigned user IDs
Map of phone numbers to their service type (e.g. 'conversation')
Map of phone numbers to their friendly names
New account SID if the account has been migrated to new credentials
```json theme={null}
{
"id": "8xMPW85D2z5jgcTa5L1p",
"account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"under_ghl_account": true,
"validate_sms": true,
"location_id": "aa4PBpxnPc9bs4LSdiW7",
"migration_numbers": [],
"assigned_to_numbers": {},
"numbers": {
"+18705871861": "conversation"
},
"number_name": {
"+18705871861": "My Number"
},
"new_account_sid": ""
}
```
```json theme={null}
{
"message": "Phone number is no longer available",
"error": "Bad Request",
"statusCode": 400
}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/purchase' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"phoneNumber": "+18305551234",
"countryCode": "US",
"numberType": "local",
"addressSid": "AD1234567890abcdef1234567890abcde",
"bundleSid": "BU1234567890abcdef1234567890abcde",
"locality": "San Antonio",
"region": "TX",
"fingerprintId": "fp_abc123def456",
"skipLocationKYC": false
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/purchase', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"phoneNumber": "+18305551234", "countryCode": "US", "numberType": "local", "addressSid": "AD1234567890abcdef1234567890abcde", "bundleSid": "BU1234567890abcdef1234567890abcde", "locality": "San Antonio", "region": "TX", "fingerprintId": "fp_abc123def456", "skipLocationKYC": false}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/purchase',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"phoneNumber": "+18305551234", "countryCode": "US", "numberType": "local", "addressSid": "AD1234567890abcdef1234567890abcde", "bundleSid": "BU1234567890abcdef1234567890abcde", "locality": "San Antonio", "region": "TX", "fingerprintId": "fp_abc123def456", "skipLocationKYC": false},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'phoneNumber': '+18305551234', 'countryCode': 'US', 'numberType': 'local', 'addressSid': 'AD1234567890abcdef1234567890abcde', 'bundleSid': 'BU1234567890abcdef1234567890abcde', 'locality': 'San Antonio', 'region': 'TX', 'fingerprintId': 'fp_abc123def456', 'skipLocationKYC': false}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Product Reviews
Source: https://developers.leadwaycrm.com/api-reference/products/products-bulk-update-product-review
Update one or multiple product reviews: status, reply, etc.
Update one or multiple product reviews: status, reply, etc.
```http theme={null}
POST https://services.leadconnectorhq.com/products/reviews/bulk-update
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id or Agency Id
Posibles valores: 'account'
Array of Product Reviews
Review Id
Product Id
Store Id
Status of the review
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/reviews/bulk-update' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"reviews": [
{
"reviewId": "6578278e879ad2646715ba9c",
"productId": "6578278e879ad2646715ba9d",
"storeId": "a1b2c3d4e5f6g7h8i9j0k1l2"
}
],
"status": "approved"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/reviews/bulk-update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "reviews": [{"reviewId": "6578278e879ad2646715ba9c", "productId": "6578278e879ad2646715ba9d", "storeId": "a1b2c3d4e5f6g7h8i9j0k1l2"}], "status": "approved"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/reviews/bulk-update',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "reviews": [{"reviewId": "6578278e879ad2646715ba9c", "productId": "6578278e879ad2646715ba9d", "storeId": "a1b2c3d4e5f6g7h8i9j0k1l2"}], "status": "approved"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'reviews': [{'reviewId': '6578278e879ad2646715ba9c', 'productId': '6578278e879ad2646715ba9d', 'storeId': 'a1b2c3d4e5f6g7h8i9j0k1l2'}], 'status': 'approved'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Bulk Edit Products and Prices
Source: https://developers.leadwaycrm.com/api-reference/products/products-bulkedit
API to bulk edit products and their associated prices (max 30 entities)
API to bulk edit products and their associated prices (max 30 entities)
```http theme={null}
POST https://services.leadconnectorhq.com/products/bulk-update/edit
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id or Agency Id
Posibles valores: 'account'
Array of products to update. Note: The total count includes all prices within each product.
Product ID
Product name
Product description
Product image
Product availability in store
Array of price variants for the product
Price ID
Price name
Price amount
Price currency
Compare at price
Available quantity
Track inventory
Allow out of stock purchases
SKU
Trial period in days
Total billing cycles
Setup fee
Shipping options
Recurring details
Collection IDs
Enable product label
Enable taxes
SEO metadata for the product
Product URL slug
Automatic tax category ID
Tax inclusive pricing
Product taxes
Product media
Product label
## Respuestas
Success message
Operation status
Number of products updated
```json theme={null}
{
"message": "Products updated successfully",
"status": true,
"updatedCount": 5
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/bulk-update/edit' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"products": [
{
"_id": "64a1b2c3d4e5f67890123456",
"name": "Premium Product",
"description": "A high-quality premium product with excellent features and durability",
"image": "https://example.com/product-image.jpg",
"availableInStore": true,
"prices": [
{}
],
"collectionIds": [
"64a1b2c3d4e5f67890123458",
"64a1b2c3d4e5f67890123459"
],
"isLabelEnabled": true,
"isTaxesEnabled": true,
"slug": "premium-product",
"automaticTaxCategoryId": "64a1b2c3d4e5f67890123460",
"taxInclusive": false,
"taxes": [
{}
],
"medias": [
{}
],
"label": {}
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/bulk-update/edit', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "products": [{"_id": "64a1b2c3d4e5f67890123456", "name": "Premium Product", "description": "A high-quality premium product with excellent features and durability", "image": "https://example.com/product-image.jpg", "availableInStore": true, "prices": [{}], "collectionIds": ["64a1b2c3d4e5f67890123458", "64a1b2c3d4e5f67890123459"], "isLabelEnabled": true, "isTaxesEnabled": true, "slug": "premium-product", "automaticTaxCategoryId": "64a1b2c3d4e5f67890123460", "taxInclusive": false, "taxes": [{}], "medias": [{}], "label": {}}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/bulk-update/edit',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "products": [{"_id": "64a1b2c3d4e5f67890123456", "name": "Premium Product", "description": "A high-quality premium product with excellent features and durability", "image": "https://example.com/product-image.jpg", "availableInStore": true, "prices": [{}], "collectionIds": ["64a1b2c3d4e5f67890123458", "64a1b2c3d4e5f67890123459"], "isLabelEnabled": true, "isTaxesEnabled": true, "slug": "premium-product", "automaticTaxCategoryId": "64a1b2c3d4e5f67890123460", "taxInclusive": false, "taxes": [{}], "medias": [{}], "label": {}}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'products': [{'_id': '64a1b2c3d4e5f67890123456', 'name': 'Premium Product', 'description': 'A high-quality premium product with excellent features and durability', 'image': 'https://example.com/product-image.jpg', 'availableInStore': true, 'prices': [{}], 'collectionIds': ['64a1b2c3d4e5f67890123458', '64a1b2c3d4e5f67890123459'], 'isLabelEnabled': true, 'isTaxesEnabled': true, 'slug': 'premium-product', 'automaticTaxCategoryId': '64a1b2c3d4e5f67890123460', 'taxInclusive': false, 'taxes': [{}], 'medias': [{}], 'label': {}}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Bulk Update Products
Source: https://developers.leadwaycrm.com/api-reference/products/products-bulkupdate
API to bulk update products (price, availability, collections, delete)
API to bulk update products (price, availability, collections, delete)
```http theme={null}
POST https://services.leadconnectorhq.com/products/bulk-update
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id or Agency Id
Posibles valores: 'account'
Type of bulk update operation Posibles valores: 'bulk-update-price', 'bulk-update-availability', 'bulk-update-product-collection', 'bulk-delete-products', 'bulk-update-currency'
Array of product IDs
Filters to apply when selectAll is true
Price update configuration
Compare at price update configuration
New availability status
Array of collection IDs
Currency code
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/bulk-update' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"type": "bulk-update-price",
"productIds": [
"5f8d0d55b54764421b7156c1"
],
"availability": true,
"collectionIds": [
"string"
],
"currency": "USD"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/bulk-update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "type": "bulk-update-price", "productIds": ["5f8d0d55b54764421b7156c1"], "availability": true, "collectionIds": ["string"], "currency": "USD"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/bulk-update',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "type": "bulk-update-price", "productIds": ["5f8d0d55b54764421b7156c1"], "availability": true, "collectionIds": ["string"], "currency": "USD"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'type': 'bulk-update-price', 'productIds': ['5f8d0d55b54764421b7156c1'], 'availability': true, 'collectionIds': ['string'], 'currency': 'USD'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Price for a Product
Source: https://developers.leadwaycrm.com/api-reference/products/products-create-price-for-product
The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product
The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product. Ensure that the required information is provided in the request payload.
```http theme={null}
POST https://services.leadconnectorhq.com/products/{productId}/price
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the product that needs to be used
## Body
The name of the price.
The type of the price. Posibles valores: 'one\_time', 'recurring'
The currency of the price.
The amount of the price. ( min: 0 )
The recurring details of the price (if type is recurring).
A brief description of the price.
An array of membership offers associated with the price.
Membership offer label
Membership offer label
The unique identifier for the membership offer.
The trial period duration in days (if applicable).
The total number of billing cycles for the price. ( min: 1 )
The setup fee for the price.
An array of variant option IDs associated with the price.
The compare at price for the price.
The unique identifier of the account associated with the price.
The unique identifier of the user who created the price.
Additional metadata associated with the price.
Need to track inventory stock quantity
Available inventory stock quantity
Continue selling when out of stock
The unique identifier of the SKU associated with the price
Shipping options of the Price
Is the product a digital product
Digital delivery options
## Respuestas
The unique identifier for the price.
An array of membership offers associated with the price.
Membership offer label
Membership offer label
The unique identifier for the membership offer.
An array of variant option IDs associated with the price.
The unique identifier for the account.
The unique identifier for the associated product.
The unique identifier for the user.
The name of the price.
The type of the price (e.g., one\_time). Posibles valores: 'one\_time', 'recurring'
The currency code for the price.
The amount of the price.
The recurring details of the price (if type is recurring).
The creation timestamp of the price.
The last update timestamp of the price.
The compare-at price for comparison purposes.
Indicates whether inventory tracking is enabled.
Available inventory stock quantity
Continue selling when out of stock
```json theme={null}
{
"_id": "655b33aa2209e60b6adb87a7",
"membershipOffers": [
{
"label": "top_50",
"value": "50",
"_id": "655b33aa2209e60b6adb87a7"
}
],
"variantOptionIds": [
"h4z7u0im2q8",
"h3nst2ltsnn"
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"product": "655b33a82209e60b6adb87a5",
"userId": "6YAtzfzpmHAdj0e8GkKp",
"name": "Red / S",
"type": "one_time",
"currency": "INR",
"amount": 199999,
"createdAt": "2023-11-20T10:23:38.645Z",
"updatedAt": "2024-01-23T09:57:04.852Z",
"compareAtPrice": 2000000,
"availableQuantity": 5,
"allowOutOfStockPurchases": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/YOUR_productId/price' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "Price Name",
"type": "one_time",
"currency": "USD",
"amount": 99.99,
"description": "string",
"membershipOffers": [
{
"label": "top_50",
"value": "50",
"_id": "655b33aa2209e60b6adb87a7"
}
],
"trialPeriod": 7,
"totalCycles": 12,
"setupFee": 10.99,
"variantOptionIds": [
"option_id_1",
"option_id_2"
],
"compareAtPrice": 19.99,
"locationId": "6578278e879ad2646715ba9c",
"userId": "6578278e879ad2646715ba9c",
"trackInventory": true,
"availableQuantity": 5,
"allowOutOfStockPurchases": true,
"sku": "sku_123",
"isDigitalProduct": true,
"digitalDelivery": [
"string"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId/price', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "Price Name", "type": "one_time", "currency": "USD", "amount": 99.99, "description": "string", "membershipOffers": [{"label": "top_50", "value": "50", "_id": "655b33aa2209e60b6adb87a7"}], "trialPeriod": 7, "totalCycles": 12, "setupFee": 10.99, "variantOptionIds": ["option_id_1", "option_id_2"], "compareAtPrice": 19.99, "locationId": "6578278e879ad2646715ba9c", "userId": "6578278e879ad2646715ba9c", "trackInventory": true, "availableQuantity": 5, "allowOutOfStockPurchases": true, "sku": "sku_123", "isDigitalProduct": true, "digitalDelivery": ["string"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/YOUR_productId/price',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "Price Name", "type": "one_time", "currency": "USD", "amount": 99.99, "description": "string", "membershipOffers": [{"label": "top_50", "value": "50", "_id": "655b33aa2209e60b6adb87a7"}], "trialPeriod": 7, "totalCycles": 12, "setupFee": 10.99, "variantOptionIds": ["option_id_1", "option_id_2"], "compareAtPrice": 19.99, "locationId": "6578278e879ad2646715ba9c", "userId": "6578278e879ad2646715ba9c", "trackInventory": true, "availableQuantity": 5, "allowOutOfStockPurchases": true, "sku": "sku_123", "isDigitalProduct": true, "digitalDelivery": ["string"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'Price Name', 'type': 'one_time', 'currency': 'USD', 'amount': 99.99, 'description': 'string', 'membershipOffers': [{'label': 'top_50', 'value': '50', '_id': '655b33aa2209e60b6adb87a7'}], 'trialPeriod': 7, 'totalCycles': 12, 'setupFee': 10.99, 'variantOptionIds': ['option_id_1', 'option_id_2'], 'compareAtPrice': 19.99, 'locationId': '6578278e879ad2646715ba9c', 'userId': '6578278e879ad2646715ba9c', 'trackInventory': true, 'availableQuantity': 5, 'allowOutOfStockPurchases': true, 'sku': 'sku_123', 'isDigitalProduct': true, 'digitalDelivery': ['string']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Product
Source: https://developers.leadwaycrm.com/api-reference/products/products-create-product
The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request pa
The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload.
```http theme={null}
POST https://services.leadconnectorhq.com/products/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
The name of the product.
The unique identifier for the account.
A brief description of the product.
Posibles valores: 'DIGITAL', 'PHYSICAL', 'SERVICE', 'PHYSICAL/DIGITAL'
The URL for the product image.
The statement descriptor for the product.
Indicates whether the product is available in-store.
An array of medias for the product.
The unique identifier for the media.
The title of the media file.
The URL where the media file is stored.
The type of the media file (e.g., image, video will be supporting soon). Posibles valores: 'image', 'video'
Indicates whether the media is featured.
Mongo ObjectIds of the prices for which the media is assigned
An array of variants for the product.
A unique identifier for the variant.
The name of the variant.
An array of options for the variant.
The unique identifier for the option.
The name of the option.
An array of category Ids for the product
Are there any taxes attached to the product. If this is true, taxes array cannot be empty.
List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
Tax category ID for Automatic taxes calculation.
Is the product label enabled. If this is true, label object cannot be empty.
Details for Product Label
The slug using which the product navigation will be handled
SEO data for the product that will be displayed in the preview
Whether the taxes should be included in the purchase price
## Respuestas
The unique identifier for the product.
product description
An array of variants for the product.
A unique identifier for the variant.
The name of the variant.
An array of options for the variant.
The unique identifier for the option.
The name of the option.
The unique identifier for the account.
The name of the product.
The type of the product (e.g., PHYSICAL).
Indicates whether the product is available in-store.
The creation timestamp of the product.
The last update timestamp of the product.
The statement descriptor for the product.
The URL for the product image.
An array of category Ids for the product
The field indicates whether taxes are enabled for the product or not.
An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.
Tax category ID for Automatic taxes calculation.
The Product label details
The slug of the product by which the product will be navigated
```json theme={null}
{
"_id": "655b33a82209e60b6adb87a5",
"description": "This is a really awesome product",
"variants": [
{
"id": "38s63qmxfr4",
"name": "Size",
"options": [
{}
]
}
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"name": "Awesome Product",
"productType": "PHYSICAL",
"availableInStore": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"statementDescriptor": "abcde",
"image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
"collectionIds": [
"65d71377c326ea78e1c47df5",
"65d71377c326ea78e1c47d34"
],
"isTaxesEnabled": true,
"taxes": [
"654492a4e6bef380114de15a"
],
"automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
"slug": "washing-machine"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "Awesome Product",
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"description": "Product description goes here.",
"productType": "DIGITAL",
"image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
"statementDescriptor": "abcde",
"availableInStore": true,
"medias": [
{
"id": "fzrgusiuu0m",
"title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png",
"url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png",
"type": "image",
"isFeatured": true,
"priceIds": "6578278e879ad2646715ba9c"
}
],
"variants": [
{
"id": "38s63qmxfr4",
"name": "Size",
"options": [
{}
]
}
],
"collectionIds": [
"65d71377c326ea78e1c47df5",
"65d71377c326ea78e1c47d34"
],
"isTaxesEnabled": true,
"taxes": [
"654492a4e6bef380114de15a"
],
"automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
"isLabelEnabled": true,
"slug": "awesome-product",
"taxInclusive": true
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "Awesome Product", "locationId": "3SwdhCsvxI8Au3KsPJt6", "description": "Product description goes here.", "productType": "DIGITAL", "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png", "statementDescriptor": "abcde", "availableInStore": true, "medias": [{"id": "fzrgusiuu0m", "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png", "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png", "type": "image", "isFeatured": true, "priceIds": "6578278e879ad2646715ba9c"}], "variants": [{"id": "38s63qmxfr4", "name": "Size", "options": [{}]}], "collectionIds": ["65d71377c326ea78e1c47df5", "65d71377c326ea78e1c47d34"], "isTaxesEnabled": true, "taxes": ["654492a4e6bef380114de15a"], "automaticTaxCategoryId": "65d71377c326ea78e1c47df5", "isLabelEnabled": true, "slug": "awesome-product", "taxInclusive": true}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "Awesome Product", "locationId": "3SwdhCsvxI8Au3KsPJt6", "description": "Product description goes here.", "productType": "DIGITAL", "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png", "statementDescriptor": "abcde", "availableInStore": true, "medias": [{"id": "fzrgusiuu0m", "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png", "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png", "type": "image", "isFeatured": true, "priceIds": "6578278e879ad2646715ba9c"}], "variants": [{"id": "38s63qmxfr4", "name": "Size", "options": [{}]}], "collectionIds": ["65d71377c326ea78e1c47df5", "65d71377c326ea78e1c47d34"], "isTaxesEnabled": true, "taxes": ["654492a4e6bef380114de15a"], "automaticTaxCategoryId": "65d71377c326ea78e1c47df5", "isLabelEnabled": true, "slug": "awesome-product", "taxInclusive": true},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'Awesome Product', 'locationId': '3SwdhCsvxI8Au3KsPJt6', 'description': 'Product description goes here.', 'productType': 'DIGITAL', 'image': 'https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png', 'statementDescriptor': 'abcde', 'availableInStore': true, 'medias': [{'id': 'fzrgusiuu0m', 'title': '1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png', 'url': 'https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png', 'type': 'image', 'isFeatured': true, 'priceIds': '6578278e879ad2646715ba9c'}], 'variants': [{'id': '38s63qmxfr4', 'name': 'Size', 'options': [{}]}], 'collectionIds': ['65d71377c326ea78e1c47df5', '65d71377c326ea78e1c47d34'], 'isTaxesEnabled': true, 'taxes': ['654492a4e6bef380114de15a'], 'automaticTaxCategoryId': '65d71377c326ea78e1c47df5', 'isLabelEnabled': true, 'slug': 'awesome-product', 'taxInclusive': true}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Create Product Collection
Source: https://developers.leadwaycrm.com/api-reference/products/products-create-product-collection
Create a new Product Collection for a specific account
Create a new Product Collection for a specific account
```http theme={null}
POST https://services.leadconnectorhq.com/products/collections
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
The type of alt. For now it is only LOCATION Posibles valores: 'account'
Unique Identifier of the Product Collection, Mongo Id
Name of the Product Collection
Slug of the Product Collection which helps in navigation
The URL of the image that is going to be displayed as the collection Thumbnail
The metadata information which will be displayed in SEO previews
## Respuestas
created Collection
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/collections' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "LOCATION",
"collectionId": "66057f9d28536eae584ec047",
"name": "Best Sellers",
"slug": "best-sellers",
"image": "http://example.com/watermark.png"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/collections', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "LOCATION", "collectionId": "66057f9d28536eae584ec047", "name": "Best Sellers", "slug": "best-sellers", "image": "http://example.com/watermark.png"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/collections',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "LOCATION", "collectionId": "66057f9d28536eae584ec047", "name": "Best Sellers", "slug": "best-sellers", "image": "http://example.com/watermark.png"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'LOCATION', 'collectionId': '66057f9d28536eae584ec047', 'name': 'Best Sellers', 'slug': 'best-sellers', 'image': 'http://example.com/watermark.png'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Price by ID for a Product
Source: https://developers.leadwaycrm.com/api-reference/products/products-delete-price-by-id-for-product
The "Delete Price by ID for a Product" API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoint to remove a price from the system.
The "Delete Price by ID for a Product" API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoint to remove a price from the system.
```http theme={null}
DELETE https://services.leadconnectorhq.com/products/{productId}/price/{priceId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the product that needs to be used
ID of the price that needs to be returned
## Query parameters
account Id
## Respuestas
returns true if the price is successfully deleted
```json theme={null}
{
"status": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Product by ID
Source: https://developers.leadwaycrm.com/api-reference/products/products-delete-product-by-id
The "Delete Product by ID" API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system.
The "Delete Product by ID" API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system.
```http theme={null}
DELETE https://services.leadconnectorhq.com/products/{productId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID or the slug of the product that needs to be returned
## Query parameters
account Id
Parameter which will decide whether to show the wishlisting status of products
## Respuestas
returns true if the product is successfully deleted
```json theme={null}
{
"status": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/products/YOUR_productId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/products/YOUR_productId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Product Collection
Source: https://developers.leadwaycrm.com/api-reference/products/products-delete-product-collection
Delete specific product collection with Id :collectionId
Delete specific product collection with Id :collectionId
```http theme={null}
DELETE https://services.leadconnectorhq.com/products/collections/{collectionId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
MongoId of the collection
## Query parameters
Account Id
The type of alt. For now it is only LOCATION
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/products/collections/YOUR_collectionId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/collections/YOUR_collectionId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/products/collections/YOUR_collectionId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Delete Product Review
Source: https://developers.leadwaycrm.com/api-reference/products/products-delete-product-review
Delete specific product review
Delete specific product review
```http theme={null}
DELETE https://services.leadconnectorhq.com/products/reviews/{reviewId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Review Id
## Query parameters
Account Id or Agency Id
Product Id of the product
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X DELETE 'https://services.leadconnectorhq.com/products/reviews/YOUR_reviewId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/reviews/YOUR_reviewId', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'DELETE',
'https://services.leadconnectorhq.com/products/reviews/YOUR_reviewId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Inventory
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-list-inventory
The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters.
The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters.
```http theme={null}
GET https://services.leadconnectorhq.com/products/inventory
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
Account Id or Agency Id
Search string for Variant Search
## Respuestas
List of inventory items
The unique identifier for the price
Name of the price/variant
Available quantity in inventory
SKU for the product variant
Whether out of stock purchases are allowed
Product ID this price belongs to
Last update timestamp
Product image URL
Product name
Total count of inventory items
```json theme={null}
{
"inventory": [
{
"_id": "6241712be68f7a98102ba272",
"name": "Medium T-shirt",
"availableQuantity": 50,
"sku": "TSHIRT-MED-001",
"allowOutOfStockPurchases": false,
"product": "6241712be68f7a98102ba270",
"updatedAt": "2023-12-12T09:27:42.355Z",
"image": "https://example.com/images/product.jpg",
"productName": "T-shirt"
}
],
"total": {
"total": 100
}
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/inventory' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/inventory', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/inventory',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Price by ID for a Product
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-price-by-id-for-product
The "Get Price by ID for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a si
The "Get Price by ID for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a single price based on the provided price ID and product ID.
```http theme={null}
GET https://services.leadconnectorhq.com/products/{productId}/price/{priceId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the product that needs to be used
ID of the price that needs to be returned
## Query parameters
account Id
## Respuestas
The unique identifier for the price.
An array of membership offers associated with the price.
Membership offer label
Membership offer label
The unique identifier for the membership offer.
An array of variant option IDs associated with the price.
The unique identifier for the account.
The unique identifier for the associated product.
The unique identifier for the user.
The name of the price.
The type of the price (e.g., one\_time). Posibles valores: 'one\_time', 'recurring'
The currency code for the price.
The amount of the price.
The recurring details of the price (if type is recurring).
The creation timestamp of the price.
The last update timestamp of the price.
The compare-at price for comparison purposes.
Indicates whether inventory tracking is enabled.
Available inventory stock quantity
Continue selling when out of stock
```json theme={null}
{
"_id": "655b33aa2209e60b6adb87a7",
"membershipOffers": [
{
"label": "top_50",
"value": "50",
"_id": "655b33aa2209e60b6adb87a7"
}
],
"variantOptionIds": [
"h4z7u0im2q8",
"h3nst2ltsnn"
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"product": "655b33a82209e60b6adb87a5",
"userId": "6YAtzfzpmHAdj0e8GkKp",
"name": "Red / S",
"type": "one_time",
"currency": "INR",
"amount": 199999,
"createdAt": "2023-11-20T10:23:38.645Z",
"updatedAt": "2024-01-23T09:57:04.852Z",
"compareAtPrice": 2000000,
"availableQuantity": 5,
"allowOutOfStockPurchases": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Product by ID
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-product-by-id
The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product ID.
The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product ID.
```http theme={null}
GET https://services.leadconnectorhq.com/products/{productId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID or the slug of the product that needs to be returned
## Query parameters
account Id
Parameter which will decide whether to show the wishlisting status of products
## Respuestas
The unique identifier for the product.
product description
An array of variants for the product.
A unique identifier for the variant.
The name of the variant.
An array of options for the variant.
The unique identifier for the option.
The name of the option.
The unique identifier for the account.
The name of the product.
The type of the product (e.g., PHYSICAL).
Indicates whether the product is available in-store.
The creation timestamp of the product.
The last update timestamp of the product.
The statement descriptor for the product.
The URL for the product image.
An array of category Ids for the product
The field indicates whether taxes are enabled for the product or not.
An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.
Tax category ID for Automatic taxes calculation.
The Product label details
The slug of the product by which the product will be navigated
```json theme={null}
{
"_id": "655b33a82209e60b6adb87a5",
"description": "This is a really awesome product",
"variants": [
{
"id": "38s63qmxfr4",
"name": "Size",
"options": [
{}
]
}
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"name": "Awesome Product",
"productType": "PHYSICAL",
"availableInStore": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"statementDescriptor": "abcde",
"image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
"collectionIds": [
"65d71377c326ea78e1c47df5",
"65d71377c326ea78e1c47d34"
],
"isTaxesEnabled": true,
"taxes": [
"654492a4e6bef380114de15a"
],
"automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
"slug": "washing-machine"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/YOUR_productId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/YOUR_productId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch Product Collections
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-product-collection
Internal API to fetch the Product Collections
Internal API to fetch the Product Collections
```http theme={null}
GET https://services.leadconnectorhq.com/products/collections
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
Account Id
The type of alt. For now it is only LOCATION
Ids of the collections separated by comma(,) for search purposes
Query to search collection based on names
## Respuestas
Array of Collections
The total count of the collections present, which is useful to calculate the pagination
```json theme={null}
{
"data": [
[]
],
"total": 0
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/collections' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/collections', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/collections',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Get Details about individual product collection
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-product-collection-id
Get Details about individual product collection
Get Details about individual product collection
```http theme={null}
GET https://services.leadconnectorhq.com/products/collections/{collectionId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Collection Id
## Query parameters
Account Id
## Respuestas
Collection Data
Status of the operation
```json theme={null}
{
"status": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/collections/YOUR_collectionId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/collections/YOUR_collectionId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/collections/YOUR_collectionId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch Product Reviews
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-product-reviews
API to fetch the Product Reviews
API to fetch the Product Reviews
```http theme={null}
GET https://services.leadconnectorhq.com/products/reviews
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id or Agency Id
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
The field upon which the sort should be applied
The order of sort which should be applied for the sortField
Key to filter the ratings
The start date for filtering reviews
The end date for filtering reviews
Comma-separated list of product IDs
Comma-separated list of store IDs
## Respuestas
Array of Collections
The total count of the collections present, which is useful to calculate the pagination
```json theme={null}
{
"data": [
[]
],
"total": 0
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/reviews' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/reviews', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/reviews',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch Product Store Stats
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-product-store-stats
API to fetch the total number of products, included in the store, and excluded from the store and other stats
API to fetch the total number of products, included in the store, and excluded from the store and other stats
```http theme={null}
GET https://services.leadconnectorhq.com/products/store/{storeId}/stats
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Products related to the store
## Query parameters
Account Id or Agency Id
The name of the product for searching.
Filter by product collection Ids. Supports comma separated values
## Respuestas
Total number of products
Number of products included in the store
Number of products excluded from the store
```json theme={null}
{
"totalProducts": 100,
"includedInStore": 80,
"excludedFromStore": 20
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/store/YOUR_storeId/stats' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/store/YOUR_storeId/stats', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/store/YOUR_storeId/stats',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Fetch Review Count as per status
Source: https://developers.leadwaycrm.com/api-reference/products/products-get-reviews-count
API to fetch the Review Count as per status
API to fetch the Review Count as per status
```http theme={null}
GET https://services.leadconnectorhq.com/products/reviews/count
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id or Agency Id
Key to filter the ratings
The start date for filtering reviews
The end date for filtering reviews
Comma-separated list of product IDs
Comma-separated list of store IDs
## Respuestas
Array of review status counts
```json theme={null}
{
"data": [
[]
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/reviews/count' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/reviews/count', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/reviews/count',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Products
Source: https://developers.leadwaycrm.com/api-reference/products/products-list-invoices
The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. Th
The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information.
```http theme={null}
GET https://services.leadconnectorhq.com/products/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
LocationId is the id of the account
The name of the product for searching.
Filter by product category Ids. Supports comma separated values
The slug value of the collection by which the collection would be searched
Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes
List of product ids to be fetched.
fetch and project products based on the storeId
Separate products by which are included in the store and which are not
If the product is included in the online store
The order of sort which should be applied for the date
## Respuestas
An array of products
The unique identifier for the product.
product description
An array of variants for the product.
A unique identifier for the variant.
The name of the variant.
An array of options for the variant.
The unique identifier for the option.
The name of the option.
The unique identifier for the account.
The name of the product.
The type of the product (e.g., PHYSICAL).
Indicates whether the product is available in-store.
The creation timestamp of the product.
The last update timestamp of the product.
The statement descriptor for the product.
The URL for the product image.
An array of category Ids for the product
The field indicates whether taxes are enabled for the product or not.
An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.
Tax category ID for Automatic taxes calculation.
The Product label details
The slug of the product by which the product will be navigated
list products status
Total number of products
```json theme={null}
{
"products": [
{
"_id": "655b33a82209e60b6adb87a5",
"description": "This is a really awesome product",
"variants": [
{}
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"name": "Awesome Product",
"productType": "PHYSICAL",
"availableInStore": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"statementDescriptor": "abcde",
"image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
"collectionIds": [
"65d71377c326ea78e1c47df5",
"65d71377c326ea78e1c47d34"
],
"isTaxesEnabled": true,
"taxes": [
"654492a4e6bef380114de15a"
],
"automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
"slug": "washing-machine"
}
],
"total": [
{
"total": 20
}
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List Prices for a Product
Source: https://developers.leadwaycrm.com/api-reference/products/products-list-prices-for-product
The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering prices or paginate through the list using the p
The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering prices or paginate through the list using the provided query parameters.
```http theme={null}
GET https://services.leadconnectorhq.com/products/{productId}/price
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the product that needs to be used
## Query parameters
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
The unique identifier for the account.
To filter the response only with the given price ids, Please provide with comma separated
## Respuestas
An array of prices
The unique identifier for the price.
An array of membership offers associated with the price.
Membership offer label
Membership offer label
The unique identifier for the membership offer.
An array of variant option IDs associated with the price.
The unique identifier for the account.
The unique identifier for the associated product.
The unique identifier for the user.
The name of the price.
The type of the price (e.g., one\_time). Posibles valores: 'one\_time', 'recurring'
The currency code for the price.
The amount of the price.
The recurring details of the price (if type is recurring).
The creation timestamp of the price.
The last update timestamp of the price.
The compare-at price for comparison purposes.
Indicates whether inventory tracking is enabled.
Available inventory stock quantity
Continue selling when out of stock
```json theme={null}
{
"prices": [
{
"_id": "655b33aa2209e60b6adb87a7",
"membershipOffers": [
{}
],
"variantOptionIds": [
"h4z7u0im2q8",
"h3nst2ltsnn"
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"product": "655b33a82209e60b6adb87a5",
"userId": "6YAtzfzpmHAdj0e8GkKp",
"name": "Red / S",
"type": "one_time",
"currency": "INR",
"amount": 199999,
"createdAt": "2023-11-20T10:23:38.645Z",
"updatedAt": "2024-01-23T09:57:04.852Z",
"compareAtPrice": 2000000,
"availableQuantity": 5,
"allowOutOfStockPurchases": true
}
],
"total": 10
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/YOUR_productId/price' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId/price', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/YOUR_productId/price',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Update product display priorities in store
Source: https://developers.leadwaycrm.com/api-reference/products/products-update-display-priority
API to set the display priority of products in a store
API to set the display priority of products in a store
```http theme={null}
POST https://services.leadconnectorhq.com/products/store/{storeId}/priority
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Products related to the store
## Body
Account Id or Agency Id
Posibles valores: 'account'
Array of products with their display priorities
## Respuestas
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/store/YOUR_storeId/priority' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"products": [
[]
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/store/YOUR_storeId/priority', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "products": [[]]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/store/YOUR_storeId/priority',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "products": [[]]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'products': [[]]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Inventory
Source: https://developers.leadwaycrm.com/api-reference/products/products-update-inventory
The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in th
The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory.
```http theme={null}
POST https://services.leadconnectorhq.com/products/inventory
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id or Agency Id
Posibles valores: 'account'
Array of items to update in the inventory.
The unique identifier for the price, in MongoDB ID format.
The available quantity of the item.
Whether to continue selling the item when out of stock.
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/inventory' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"items": [
{
"priceId": "5e9f8f8f8f8f8f8f8f8f8f8",
"availableQuantity": 10,
"allowOutOfStockPurchases": false
}
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/inventory', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "items": [{"priceId": "5e9f8f8f8f8f8f8f8f8f8f8", "availableQuantity": 10, "allowOutOfStockPurchases": false}]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/inventory',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "items": [{"priceId": "5e9f8f8f8f8f8f8f8f8f8f8", "availableQuantity": 10, "allowOutOfStockPurchases": false}]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'items': [{'priceId': '5e9f8f8f8f8f8f8f8f8f8f8', 'availableQuantity': 10, 'allowOutOfStockPurchases': false}]}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Price by ID for a Product
Source: https://developers.leadwaycrm.com/api-reference/products/products-update-price-by-id-for-product
The "Update Price by ID for a Product" API allows modifying information for a specific price associated with a particular product using its unique identifier. Use this endpoint to update details for a
The "Update Price by ID for a Product" API allows modifying information for a specific price associated with a particular product using its unique identifier. Use this endpoint to update details for a single price based on the provided price ID and product ID.
```http theme={null}
PUT https://services.leadconnectorhq.com/products/{productId}/price/{priceId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID of the product that needs to be used
ID of the price that needs to be returned
## Body
The name of the price.
The type of the price. Posibles valores: 'one\_time', 'recurring'
The currency of the price.
The amount of the price. ( min: 0 )
The recurring details of the price (if type is recurring).
A brief description of the price.
An array of membership offers associated with the price.
Membership offer label
Membership offer label
The unique identifier for the membership offer.
The trial period duration in days (if applicable).
The total number of billing cycles for the price. ( min: 1 )
The setup fee for the price.
An array of variant option IDs associated with the price.
The compare at price for the price.
The unique identifier of the account associated with the price.
The unique identifier of the user who created the price.
Additional metadata associated with the price.
Need to track inventory stock quantity
Available inventory stock quantity
Continue selling when out of stock
The unique identifier of the SKU associated with the price
Shipping options of the Price
Is the product a digital product
Digital delivery options
## Respuestas
The unique identifier for the price.
An array of membership offers associated with the price.
Membership offer label
Membership offer label
The unique identifier for the membership offer.
An array of variant option IDs associated with the price.
The unique identifier for the account.
The unique identifier for the associated product.
The unique identifier for the user.
The name of the price.
The type of the price (e.g., one\_time). Posibles valores: 'one\_time', 'recurring'
The currency code for the price.
The amount of the price.
The recurring details of the price (if type is recurring).
The creation timestamp of the price.
The last update timestamp of the price.
The compare-at price for comparison purposes.
Indicates whether inventory tracking is enabled.
Available inventory stock quantity
Continue selling when out of stock
```json theme={null}
{
"_id": "655b33aa2209e60b6adb87a7",
"membershipOffers": [
{
"label": "top_50",
"value": "50",
"_id": "655b33aa2209e60b6adb87a7"
}
],
"variantOptionIds": [
"h4z7u0im2q8",
"h3nst2ltsnn"
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"product": "655b33a82209e60b6adb87a5",
"userId": "6YAtzfzpmHAdj0e8GkKp",
"name": "Red / S",
"type": "one_time",
"currency": "INR",
"amount": 199999,
"createdAt": "2023-11-20T10:23:38.645Z",
"updatedAt": "2024-01-23T09:57:04.852Z",
"compareAtPrice": 2000000,
"availableQuantity": 5,
"allowOutOfStockPurchases": true
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "Price Name",
"type": "one_time",
"currency": "USD",
"amount": 99.99,
"description": "string",
"membershipOffers": [
{
"label": "top_50",
"value": "50",
"_id": "655b33aa2209e60b6adb87a7"
}
],
"trialPeriod": 7,
"totalCycles": 12,
"setupFee": 10.99,
"variantOptionIds": [
"option_id_1",
"option_id_2"
],
"compareAtPrice": 19.99,
"locationId": "6578278e879ad2646715ba9c",
"userId": "6578278e879ad2646715ba9c",
"trackInventory": true,
"availableQuantity": 5,
"allowOutOfStockPurchases": true,
"sku": "sku_123",
"isDigitalProduct": true,
"digitalDelivery": [
"string"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "Price Name", "type": "one_time", "currency": "USD", "amount": 99.99, "description": "string", "membershipOffers": [{"label": "top_50", "value": "50", "_id": "655b33aa2209e60b6adb87a7"}], "trialPeriod": 7, "totalCycles": 12, "setupFee": 10.99, "variantOptionIds": ["option_id_1", "option_id_2"], "compareAtPrice": 19.99, "locationId": "6578278e879ad2646715ba9c", "userId": "6578278e879ad2646715ba9c", "trackInventory": true, "availableQuantity": 5, "allowOutOfStockPurchases": true, "sku": "sku_123", "isDigitalProduct": true, "digitalDelivery": ["string"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/products/YOUR_productId/price/YOUR_priceId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "Price Name", "type": "one_time", "currency": "USD", "amount": 99.99, "description": "string", "membershipOffers": [{"label": "top_50", "value": "50", "_id": "655b33aa2209e60b6adb87a7"}], "trialPeriod": 7, "totalCycles": 12, "setupFee": 10.99, "variantOptionIds": ["option_id_1", "option_id_2"], "compareAtPrice": 19.99, "locationId": "6578278e879ad2646715ba9c", "userId": "6578278e879ad2646715ba9c", "trackInventory": true, "availableQuantity": 5, "allowOutOfStockPurchases": true, "sku": "sku_123", "isDigitalProduct": true, "digitalDelivery": ["string"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'Price Name', 'type': 'one_time', 'currency': 'USD', 'amount': 99.99, 'description': 'string', 'membershipOffers': [{'label': 'top_50', 'value': '50', '_id': '655b33aa2209e60b6adb87a7'}], 'trialPeriod': 7, 'totalCycles': 12, 'setupFee': 10.99, 'variantOptionIds': ['option_id_1', 'option_id_2'], 'compareAtPrice': 19.99, 'locationId': '6578278e879ad2646715ba9c', 'userId': '6578278e879ad2646715ba9c', 'trackInventory': true, 'availableQuantity': 5, 'allowOutOfStockPurchases': true, 'sku': 'sku_123', 'isDigitalProduct': true, 'digitalDelivery': ['string']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Product by ID
Source: https://developers.leadwaycrm.com/api-reference/products/products-update-product-by-id
The "Update Product by ID" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a single product based on the provided product I
The "Update Product by ID" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a single product based on the provided product ID.
```http theme={null}
PUT https://services.leadconnectorhq.com/products/{productId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
ID or the slug of the product that needs to be returned
## Body
The name of the product.
The unique identifier for the account.
A brief description of the product.
Posibles valores: 'DIGITAL', 'PHYSICAL', 'SERVICE', 'PHYSICAL/DIGITAL'
The URL for the product image.
The statement descriptor for the product.
Indicates whether the product is available in-store.
An array of medias for the product.
The unique identifier for the media.
The title of the media file.
The URL where the media file is stored.
The type of the media file (e.g., image, video will be supporting soon). Posibles valores: 'image', 'video'
Indicates whether the media is featured.
Mongo ObjectIds of the prices for which the media is assigned
An array of variants for the product.
A unique identifier for the variant.
The name of the variant.
An array of options for the variant.
The unique identifier for the option.
The name of the option.
An array of category Ids for the product
Are there any taxes attached to the product. If this is true, taxes array cannot be empty.
List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
Tax category ID for Automatic taxes calculation.
Is the product label enabled. If this is true, label object cannot be empty.
Details for Product Label
The slug using which the product navigation will be handled
SEO data for the product that will be displayed in the preview
Whether the taxes should be included in the purchase price
The prices of the product
## Respuestas
The unique identifier for the product.
product description
An array of variants for the product.
A unique identifier for the variant.
The name of the variant.
An array of options for the variant.
The unique identifier for the option.
The name of the option.
The unique identifier for the account.
The name of the product.
The type of the product (e.g., PHYSICAL).
Indicates whether the product is available in-store.
The creation timestamp of the product.
The last update timestamp of the product.
The statement descriptor for the product.
The URL for the product image.
An array of category Ids for the product
The field indicates whether taxes are enabled for the product or not.
An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.
Tax category ID for Automatic taxes calculation.
The Product label details
The slug of the product by which the product will be navigated
```json theme={null}
{
"_id": "655b33a82209e60b6adb87a5",
"description": "This is a really awesome product",
"variants": [
{
"id": "38s63qmxfr4",
"name": "Size",
"options": [
{}
]
}
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"name": "Awesome Product",
"productType": "PHYSICAL",
"availableInStore": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"statementDescriptor": "abcde",
"image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
"collectionIds": [
"65d71377c326ea78e1c47df5",
"65d71377c326ea78e1c47d34"
],
"isTaxesEnabled": true,
"taxes": [
"654492a4e6bef380114de15a"
],
"automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
"slug": "washing-machine"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/products/YOUR_productId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"name": "Awesome Product",
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"description": "Product description goes here.",
"productType": "DIGITAL",
"image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
"statementDescriptor": "abcde",
"availableInStore": true,
"medias": [
{
"id": "fzrgusiuu0m",
"title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png",
"url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png",
"type": "image",
"isFeatured": true,
"priceIds": "6578278e879ad2646715ba9c"
}
],
"variants": [
{
"id": "38s63qmxfr4",
"name": "Size",
"options": [
{}
]
}
],
"collectionIds": [
"65d71377c326ea78e1c47df5",
"65d71377c326ea78e1c47d34"
],
"isTaxesEnabled": true,
"taxes": [
"654492a4e6bef380114de15a"
],
"automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
"isLabelEnabled": true,
"slug": "awesome-product",
"taxInclusive": true,
"prices": [
"string"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name": "Awesome Product", "locationId": "3SwdhCsvxI8Au3KsPJt6", "description": "Product description goes here.", "productType": "DIGITAL", "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png", "statementDescriptor": "abcde", "availableInStore": true, "medias": [{"id": "fzrgusiuu0m", "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png", "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png", "type": "image", "isFeatured": true, "priceIds": "6578278e879ad2646715ba9c"}], "variants": [{"id": "38s63qmxfr4", "name": "Size", "options": [{}]}], "collectionIds": ["65d71377c326ea78e1c47df5", "65d71377c326ea78e1c47d34"], "isTaxesEnabled": true, "taxes": ["654492a4e6bef380114de15a"], "automaticTaxCategoryId": "65d71377c326ea78e1c47df5", "isLabelEnabled": true, "slug": "awesome-product", "taxInclusive": true, "prices": ["string"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/products/YOUR_productId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"name": "Awesome Product", "locationId": "3SwdhCsvxI8Au3KsPJt6", "description": "Product description goes here.", "productType": "DIGITAL", "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png", "statementDescriptor": "abcde", "availableInStore": true, "medias": [{"id": "fzrgusiuu0m", "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png", "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png", "type": "image", "isFeatured": true, "priceIds": "6578278e879ad2646715ba9c"}], "variants": [{"id": "38s63qmxfr4", "name": "Size", "options": [{}]}], "collectionIds": ["65d71377c326ea78e1c47df5", "65d71377c326ea78e1c47d34"], "isTaxesEnabled": true, "taxes": ["654492a4e6bef380114de15a"], "automaticTaxCategoryId": "65d71377c326ea78e1c47df5", "isLabelEnabled": true, "slug": "awesome-product", "taxInclusive": true, "prices": ["string"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'name': 'Awesome Product', 'locationId': '3SwdhCsvxI8Au3KsPJt6', 'description': 'Product description goes here.', 'productType': 'DIGITAL', 'image': 'https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png', 'statementDescriptor': 'abcde', 'availableInStore': true, 'medias': [{'id': 'fzrgusiuu0m', 'title': '1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png', 'url': 'https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png', 'type': 'image', 'isFeatured': true, 'priceIds': '6578278e879ad2646715ba9c'}], 'variants': [{'id': '38s63qmxfr4', 'name': 'Size', 'options': [{}]}], 'collectionIds': ['65d71377c326ea78e1c47df5', '65d71377c326ea78e1c47d34'], 'isTaxesEnabled': true, 'taxes': ['654492a4e6bef380114de15a'], 'automaticTaxCategoryId': '65d71377c326ea78e1c47df5', 'isLabelEnabled': true, 'slug': 'awesome-product', 'taxInclusive': true, 'prices': ['string']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Product Collection
Source: https://developers.leadwaycrm.com/api-reference/products/products-update-product-collection
Update a specific product collection with Id :collectionId
Update a specific product collection with Id :collectionId
```http theme={null}
PUT https://services.leadconnectorhq.com/products/collections/{collectionId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
MongoId of the collection
## Body
Account Id
The type of alt. For now it is only LOCATION Posibles valores: 'account'
Name of the Product Collection
Slug of the Product Collection which helps in navigation
The URL of the image that is going to be displayed as the collection Thumbnail
The metadata information which will be displayed in SEO previews
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/products/collections/YOUR_collectionId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "LOCATION",
"name": "Best Sellers",
"slug": "best-sellers",
"image": "http://example.com/watermark.png"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/collections/YOUR_collectionId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "LOCATION", "name": "Best Sellers", "slug": "best-sellers", "image": "http://example.com/watermark.png"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/products/collections/YOUR_collectionId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "LOCATION", "name": "Best Sellers", "slug": "best-sellers", "image": "http://example.com/watermark.png"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'LOCATION', 'name': 'Best Sellers', 'slug': 'best-sellers', 'image': 'http://example.com/watermark.png'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Update Product Reviews
Source: https://developers.leadwaycrm.com/api-reference/products/products-update-product-review
Update status, reply, etc of a particular review
Update status, reply, etc of a particular review
```http theme={null}
PUT https://services.leadconnectorhq.com/products/reviews/{reviewId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Review Id
## Body
Account Id or Agency Id
Posibles valores: 'account'
Product Id
Status of the review
Reply of the review
Headline of the Review
Detailed Review of the product
User who is giving the review/reply
Rating of the product
Headline of the Review
Detailed Review of the product
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X PUT 'https://services.leadconnectorhq.com/products/reviews/YOUR_reviewId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"productId": "6578278e879ad2646715ba9c",
"status": "approved",
"reply": [
{
"headline": "Amazing product with great quality",
"comment": "This product exceeded my expectations in terms of quality and performance. Highly recommended!"
}
],
"rating": "4.5",
"headline": "Amazing product with great quality",
"detail": "The product is for sure a must and recommended buy"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/reviews/YOUR_reviewId', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "productId": "6578278e879ad2646715ba9c", "status": "approved", "reply": [{"headline": "Amazing product with great quality", "comment": "This product exceeded my expectations in terms of quality and performance. Highly recommended!"}], "rating": "4.5", "headline": "Amazing product with great quality", "detail": "The product is for sure a must and recommended buy"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'PUT',
'https://services.leadconnectorhq.com/products/reviews/YOUR_reviewId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "productId": "6578278e879ad2646715ba9c", "status": "approved", "reply": [{"headline": "Amazing product with great quality", "comment": "This product exceeded my expectations in terms of quality and performance. Highly recommended!"}], "rating": "4.5", "headline": "Amazing product with great quality", "detail": "The product is for sure a must and recommended buy"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'productId': '6578278e879ad2646715ba9c', 'status': 'approved', 'reply': [{'headline': 'Amazing product with great quality', 'comment': 'This product exceeded my expectations in terms of quality and performance. Highly recommended!'}], 'rating': '4.5', 'headline': 'Amazing product with great quality', 'detail': 'The product is for sure a must and recommended buy'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Action to include/exclude the product in store
Source: https://developers.leadwaycrm.com/api-reference/products/products-update-store-status
API to update the status of products in a particular store
API to update the status of products in a particular store
```http theme={null}
POST https://services.leadconnectorhq.com/products/store/{storeId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Products related to the store
## Body
Account Id or Agency Id
Posibles valores: 'account'
Action to include or exclude the product from the store Posibles valores: 'include', 'exclude'
Array of product IDs
## Respuestas
Status of api action
Success message
```json theme={null}
{
"status": true,
"message": "Successfully created"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/products/store/YOUR_storeId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"action": "include",
"productIds": [
"productId1",
"productId2"
]
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/store/YOUR_storeId', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "action": "include", "productIds": ["productId1", "productId2"]}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/products/store/YOUR_storeId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "action": "include", "productIds": ["productId1", "productId2"]},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'action': 'include', 'productIds': ['productId1', 'productId2']}),
]);
$data = json_decode(curl_exec($ch), true);
```
# List documents
Source: https://developers.leadwaycrm.com/api-reference/proposals/proposals-list-documents-contracts
List documents for a account
List documents for a account
```http theme={null}
GET https://services.leadconnectorhq.com/proposals/document
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id
Document status, pass as comma separated values
Payment status, pass as comma separated values
Limit to fetch number of records
Skip number of records
Search string
Date start from (ISO 8601), dateFrom & DateTo must be provided together
Date to (ISO 8601), dateFrom & DateTo must be provided together
## Respuestas
List of documents
Account Id
Document Id
Unique identifier
Name of the document
Type of the document
Whether the document is deleted
Whether the document is expired
Number of times document is moved to draft state
Fillable fields
Field Id
Is the field required
Has the field been completed
Recipient
Entity type Posibles valores: 'contacts', 'users'
Id
Element type Posibles valores: 'Page', 'Text', 'Image', 'Video', 'Table', 'ProductList', 'PageBreak', 'Signature', 'PaymentDetails', 'TextField', 'DateField', 'InitialsField', 'Checkbox', 'Row', 'Column'
Value of the field
Grand total object of the document
Locale of the account
Document status
Payment status
Recipients
Recipient Id
Recipient First Name
Recipient Last Name
Recipient Email
Recipient Phone Number
Recipient Phone
Recipient has completed the document
Recipient role Posibles valores: 'user', 'signer'
Recipient is primary
Recipient signing order
Recipient image url
Recipient ip
Recipient user agent
Recipient signed date
Recipient contact name
Recipient country
Recipient entity name
Recipient initials image url
Recipient last viewed date
Share link
Links for the document if its sent
Reference ID
Document ID
Recipient ID
Entity name that the recipient belongs to Posibles valores: 'contacts', 'users'
Recipient category (recipient, cc, or bcc) Posibles valores: 'recipient', 'cc', 'bcc'
Document revision number
Created by user ID
Whether the document is deleted
Date start from (ISO 8601)
Date to (ISO 8601)
Total records available
WhiteLabel url for document
WhiteLabel url for invoice
```json theme={null}
{
"documents": [
{
"locationId": "hTlkh7t8gujsahgg93",
"documentId": "hTlkh7t8gujsahgg93",
"_id": "67ac9a51106ee8311e911XXXX",
"name": "Document Name",
"type": "proposal",
"deleted": false,
"isExpired": false,
"documentRevision": 1,
"fillableFields": [
{}
],
"locale": "en-US",
"status": "draft",
"paymentStatus": "paid",
"recipients": [
{
"id": "u240JcS0E5qE0ziHnwMm",
"email": "jim@gmail.com",
"imageUrl": "",
"contactName": "Jim Anton",
"firstName": "Jim",
"lastName": "Anton",
"role": "signer",
"hasCompleted": true,
"signingOrder": 1,
"imgUrl": "base64 image url",
"ip": "123.123.123.123"
}
],
"links": [
{}
],
"updatedAt": "2025-02-03T18:30:00.000Z",
"createdAt": "2025-02-14T18:29:59.999Z"
}
],
// truncado: 4 lineas mas
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/proposals/document' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/proposals/document', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/proposals/document',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# List templates
Source: https://developers.leadwaycrm.com/api-reference/proposals/proposals-list-documents-contracts-templates
List document contract templates for a account
List document contract templates for a account
```http theme={null}
GET https://services.leadconnectorhq.com/proposals/templates
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id
Date start from (ISO 8601)
Date to (ISO 8601)
Comma-separated template types. Valid values: proposal, estimate, contentLibrary
Template Name
If the docForm is a DocForm
User Id, required when isPublicDocument is true
Limit
Skip
## Respuestas
Array of templates
Template ID
Whether the template is deleted
Template version
Template name
Account ID
Template type Posibles valores: 'proposal', 'estimate', 'contentLibrary'
User ID who last updated the template
Whether the template is a public document
Template creation date
Template last update date
Template ID (alias for \_id)
Document count (only present when isPublicDocument is true)
Document form URL (only present when isPublicDocument is true)
Total number of templates
Trace ID for request tracking
```json theme={null}
{
"data": [
{
"_id": "685d11c371c22e636e9c04b2",
"deleted": false,
"version": 2,
"name": "New Template",
"locationId": "5rORm9p7RtxWQPzBIbTG",
"type": "proposal",
"updatedBy": "K9PSPnWjfNoE8DCf5LJZ",
"isPublicDocument": true,
"createdAt": "2025-06-26T09:24:19.305Z",
"updatedAt": "2025-06-26T09:27:32.119Z",
"id": "685d11c371c22e636e9c04b2",
"documentCount": 0,
"docFormUrl": "https://staging.sendlink.co/documents/doc-form/685d11c371c22e636e9c04b2?locale=en_US"
}
],
"total": 2,
"traceId": "d5656876-86a5-46fb-84df-788f1da7937a"
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/proposals/templates' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/proposals/templates', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/proposals/templates',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```
# Send document
Source: https://developers.leadwaycrm.com/api-reference/proposals/proposals-send-documents-contracts
Send document to a client
Send document to a client
```http theme={null}
POST https://services.leadconnectorhq.com/proposals/document/send
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Account Id
Document Id
Document Name
Medium to be used for sending the document Posibles valores: 'link', 'email'
CC Recipient
Email
Contact ID
Contact Image URL
Contact Name
First Name
Last Name
Sent ByUser Id
## Respuestas
Success status
Links for all recipients
Reference ID
Document ID
Recipient ID
Entity name that the recipient belongs to Posibles valores: 'contacts', 'users'
Recipient category (recipient, cc, or bcc) Posibles valores: 'recipient', 'cc', 'bcc'
Document revision number
Created by user ID
Whether the document is deleted
```json theme={null}
{
"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
}
]
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
## Ejemplo
```bash cURL theme={null}
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"
}'
```
```javascript Node.js theme={null}
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();
```
```python Python theme={null}
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 PHP theme={null}
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);
```
# Send template
Source: https://developers.leadwaycrm.com/api-reference/proposals/proposals-send-documents-contracts-template
Send template to a client
Send template to a client
```http theme={null}
POST https://services.leadconnectorhq.com/proposals/templates/send
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Body
Template Id
User Id
Send Document
Account Id
Contact Id
Opportunity Id
## Respuestas
Success status
Links for all recipients
Reference ID
Document ID
Recipient ID
Entity name that the recipient belongs to Posibles valores: 'contacts', 'users'
Recipient category (recipient, cc, or bcc) Posibles valores: 'recipient', 'cc', 'bcc'
Document revision number
Created by user ID
Whether the document is deleted
```json theme={null}
{
"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
}
]
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/proposals/templates/send' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"templateId": "hTlkh7t8gujsahgg93",
"userId": "hTlkh7t8gujsahgg93",
"sendDocument": true,
"locationId": "hTlkh7t8gujsahgg93",
"contactId": "hTlkh7t8gujsahgg93",
"opportunityId": "hTlkh7t8gujsahgg93"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/proposals/templates/send', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"templateId": "hTlkh7t8gujsahgg93", "userId": "hTlkh7t8gujsahgg93", "sendDocument": true, "locationId": "hTlkh7t8gujsahgg93", "contactId": "hTlkh7t8gujsahgg93", "opportunityId": "hTlkh7t8gujsahgg93"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/proposals/templates/send',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"templateId": "hTlkh7t8gujsahgg93", "userId": "hTlkh7t8gujsahgg93", "sendDocument": true, "locationId": "hTlkh7t8gujsahgg93", "contactId": "hTlkh7t8gujsahgg93", "opportunityId": "hTlkh7t8gujsahgg93"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'templateId': 'hTlkh7t8gujsahgg93', 'userId': 'hTlkh7t8gujsahgg93', 'sendDocument': true, 'locationId': 'hTlkh7t8gujsahgg93', 'contactId': 'hTlkh7t8gujsahgg93', 'opportunityId': 'hTlkh7t8gujsahgg93'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Attach facebook pages
Source: https://developers.leadwaycrm.com/api-reference/social-planner/social-planner-attach-facebook-page-group
Attach facebook pages
Attach facebook pages
```http theme={null}
POST https://services.leadconnectorhq.com/social-media-posting/oauth/{locationId}/facebook/accounts/{accountId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Account Account Id
Account Id
## Body
Company ID
## Respuestas
Success or Failure
Status Code
Message
Requested Results
```json theme={null}
{
"success": true,
"statusCode": 201,
"message": "Added Facebook Account"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/facebook/accounts/YOUR_accountId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"type": "page",
"originId": "244405****11687",
"name": "JOHN_DEO",
"avatar": "https://storage.googleapis.com/2ad21ebc23/test",
"companyId": "sdfdsfdsfEWEsdfsdsW32dd"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/facebook/accounts/YOUR_accountId', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"type": "page", "originId": "244405****11687", "name": "JOHN_DEO", "avatar": "https://storage.googleapis.com/2ad21ebc23/test", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/facebook/accounts/YOUR_accountId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"type": "page", "originId": "244405****11687", "name": "JOHN_DEO", "avatar": "https://storage.googleapis.com/2ad21ebc23/test", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'type': 'page', 'originId': '244405****11687', 'name': 'JOHN_DEO', 'avatar': 'https://storage.googleapis.com/2ad21ebc23/test', 'companyId': 'sdfdsfdsfEWEsdfsdsW32dd'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Attach Instagram Professional Accounts
Source: https://developers.leadwaycrm.com/api-reference/social-planner/social-planner-attach-instagram-page-group
Attach Instagram Professional Accounts
Attach Instagram Professional Accounts
```http theme={null}
POST https://services.leadconnectorhq.com/social-media-posting/oauth/{locationId}/instagram/accounts/{accountId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Account Account Id
Account Id
## Body
Company ID
## Respuestas
Success or Failure
Status Code
Message
Requested Results
```json theme={null}
{
"success": true,
"statusCode": 201,
"message": "Added Instagram Account"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/instagram/accounts/YOUR_accountId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"originId": "244405****11687",
"name": "JOHN_DEO",
"avatar": "string",
"pageId": "234234234242sd",
"companyId": "sdfdsfdsfEWEsdfsdsW32dd"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/instagram/accounts/YOUR_accountId', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"originId": "244405****11687", "name": "JOHN_DEO", "avatar": "string", "pageId": "234234234242sd", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/instagram/accounts/YOUR_accountId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"originId": "244405****11687", "name": "JOHN_DEO", "avatar": "string", "pageId": "234234234242sd", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'originId': '244405****11687', 'name': 'JOHN_DEO', 'avatar': 'string', 'pageId': '234234234242sd', 'companyId': 'sdfdsfdsfEWEsdfsdsW32dd'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Attach linkedin pages and profile
Source: https://developers.leadwaycrm.com/api-reference/social-planner/social-planner-attach-linkedin-page-profile
Attach linkedin pages and profile
Attach linkedin pages and profile
```http theme={null}
POST https://services.leadconnectorhq.com/social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Account Account Id
Account Id
## Body
Posibles valores: 'page', 'group', 'profile', 'account', 'business'
Company ID
## Respuestas
Success or Failure
Status Code
Message
Requested Results
```json theme={null}
{
"success": true,
"statusCode": 200,
"message": "Added LinkedIn Account"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/linkedin/accounts/YOUR_accountId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"type": "page",
"originId": "244405****11687",
"name": "JOHN_DEO",
"avatar": "string",
"urn": "string",
"companyId": "sdfdsfdsfEWEsdfsdsW32dd"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/linkedin/accounts/YOUR_accountId', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"type": "page", "originId": "244405****11687", "name": "JOHN_DEO", "avatar": "string", "urn": "string", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/linkedin/accounts/YOUR_accountId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"type": "page", "originId": "244405****11687", "name": "JOHN_DEO", "avatar": "string", "urn": "string", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'type': 'page', 'originId': '244405****11687', 'name': 'JOHN_DEO', 'avatar': 'string', 'urn': 'string', 'companyId': 'sdfdsfdsfEWEsdfsdsW32dd'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Attach Tiktok profile
Source: https://developers.leadwaycrm.com/api-reference/social-planner/social-planner-attach-tiktok-profile
Attach Tiktok profile
Attach Tiktok profile
```http theme={null}
POST https://services.leadconnectorhq.com/social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId}
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Path parameters
Account Account Id
Account Id
## Body
Posibles valores: 'page', 'group', 'profile', 'account', 'business'
Company ID
## Respuestas
Success or Failure
Status Code
Message
Requested Results
```json theme={null}
{
"success": true,
"statusCode": 201,
"message": "Added Tiktok Account"
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X POST 'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/tiktok/accounts/YOUR_accountId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"type": "page",
"originId": "244405****11687",
"name": "JOHN_DEO",
"avatar": "string",
"verified": true,
"username": "JOHN_DEO",
"companyId": "sdfdsfdsfEWEsdfsdsW32dd"
}'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/tiktok/accounts/YOUR_accountId', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"type": "page", "originId": "244405****11687", "name": "JOHN_DEO", "avatar": "string", "verified": true, "username": "JOHN_DEO", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"}),
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/social-media-posting/oauth/YOUR_locationId/tiktok/accounts/YOUR_accountId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"type": "page", "originId": "244405****11687", "name": "JOHN_DEO", "avatar": "string", "verified": true, "username": "JOHN_DEO", "companyId": "sdfdsfdsfEWEsdfsdsW32dd"},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'type': 'page', 'originId': '244405****11687', 'name': 'JOHN_DEO', 'avatar': 'string', 'verified': true, 'username': 'JOHN_DEO', 'companyId': 'sdfdsfdsfEWEsdfsdsW32dd'}),
]);
$data = json_decode(curl_exec($ch), true);
```
# Attach Twitter profile
Source: https://developers.leadwaycrm.com/api-reference/social-planner/social-planner-attach-twitter-profile
!
\
\\As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience.\\
\
\
!
\
\\As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience.\\
\
\
!
\
\\As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience.\\
\
\