Developers / Tools & Resources

CRM

This API module consists of APIs that help manage client activity and also relationships you create with your customers. From capturing leads(potential customers, converting them to actual customers to sending out email and SMS/Whatsapp notifications, these APIs provide you with that and many more.

Create Lead

Captures the details of potential customers.

#Sample cURL command
curl -X 'POST' \
'https://zas-dev.zanibal.com/api/v1/order/terminstrument/submit' \
-H 'accept: application/json; charset=UTF-8' \
-H 'Content-Type: application/json' \
-d '{
"active": true,
"annualIncome": 0,
"assignedTo": 0,
"birthDate": date,
"campaign": 0,
"convertedAccount": 0,
"convertedContact": 0,
"department": "string",
"description": "string",
"doNotCall": true,
"doNotShare": true,
"emailAddress1": "string",
"emailAddress2": "string",
"emailAddressAutoBcc": "string",
"emailOptOut": true,
"emailVerified": true,
"ethnicity": "string",
"fax": "string",
"firstName": "string",
"headOfHousehold": true,
"homePhone": "string",,
"id": 0,
"identifier": "string",
"industry": "string",
"autoRollover": true,
"label": "string",
"leadSource": "string",
"leadType": "INDIVIDUAL",
"maritalStatus": "string",
"middleName": "string",
"mobilePhone": "string",
"convertedContact": 0,
"name": "string",
"noOfDependents": 0,
"officePhone": "string",
"organization": "string",
"otherPhone": "string",
"preferredContactMethod": "string",
"preferredContactTime": "string",
"prefix": "string",
"primaryCity": "string",
"primaryCountry": "string",
"primaryLatitude": 0,
"primaryLongitude": 0,
"primaryPostCode": "string",
"primaryState": "string",
"primaryStreet": "string",
"primaryStreet1": "string",
"profession": "string",
"autoRollover": true,
"salutation": "string",
"secondaryCity": "string",
"secondaryCountry": "string",
"secondaryLatitude": 0,
"secondaryLongitude": 0,
"secondaryPostCode": "string",
"secondaryState": "string",
"secondaryStreet": "string",
"secondaryStreet1": "string",
"sex": "string",
"smsOptOut": true,
"salutation": "string",
"status": "NEW",
"suffix": "string",
"title": "string",
"typeOfEmployment": "string",
"webSite": "string",
"workflowNotes": "string",
}'

This updates a Whatsapp message sent to or from a customer based on the parameters of the message. 

#Sample cURL command
curl -X 'PUT' \
'https://zas-dev.zanibal.com/api/v1/crm/whatsapp/update' \
-H 'accept: application/json; charset=UTF-8' \
-H 'Content-Type: application/json' \
-d '{
"active": true,
"assignedTo": 0,
"attachmentsWS": [
{
"active": true,
"base64Attachment": "string",
"batchCode": "string",
"category": "string",
"description": "string",
"fileMimeType": "string",
"fileName": "string",
"fileSize": 0,
"id": 0,
"label": "string",
"name": "string",
"relatedToId": 0,
"relatedTo": "CONTACT",
"subCategory": "string",
"text": "string",
"type": "string",
"workflowNotes": "string"
}
]
"direction": "INBOUND",
"body": "string",
"campaign": 0,
"endDttm": "2022-04-25T12:18:50.153Z",
"from": "string",
"id": 0,
"label": "string",
"name": "string",
"relatedToId": 0,
"relatedTo": "CONTACT",
"startDttm": "2022-04-25T12:18:50.153Z",
"status": "IN_PROGRESS",
"subject": "string",
"template": 0,
"to": "string",
"workflowNotes": "string",
'}

Returns a call provided the id

#Sample cURL command
curl -X 'GET' \
'https://zas-dev.zanibal.com/api/v1/crm/call/find/id/001' \
-H 'accept: application/json; charset=UTF-8' \