API Guidance

All information in this section is intended for guidance only, and result will depend on your ability to deploy and construct code. Your post page and token will be given to you inside the administrator configuration menu. Some RAW JSON information is being posted so you can integrate with any coding language you prefer.

Json structure: new deal(s) / Contacts

To add a new contact, you only need to send a json structure with the contact data such as: first name, last name, number (E.164 format), email, as basic data to be able to save your contact. You can also add the value of your custom variables here, like shown in the code.

All custom fields need to be previously created inside the app in order to used in the API.

				
					[
 {
  "token": " ",
 },
 {
  "type": "INSERT",
  "number": "clients phone number",
  "status": "your status id",
  "fname": "contact´s first name",
  "lname": "contact´s last name",
  "responsible": "contact´s email"
  "customFields":[{
   "id_custom": "custom fields id",
   "value": "custom fields value"
 },
 {
   "id_custom": "custom fields id",
   "value": "custom fields value"
 }],
 },
 {
  "type": "INSERT",
  "number": "clients phone number",
  "status": "your status id",
  "fname": "contact´s first name",
  "lname": "contact´s last name",
  "responsible": "contact´s email"
  "customFields":[{
   "id_custom": "custom fields id",
   "value": "custom fields value"
 },
 {
   "id_custom": "custom fields id",
   "value": "custom fields value"
 }],
 },
]

Json structure: change status or update

This following json structure, will allow you to change the status of your contact/deal or update the information. It only requires the status id which can be consulted from your status table inside the status section with your administrator user, and your contacts cellphone number.

				
					[
 {
  "token": " ",
 },
 {
  "type": "UPDATE",
  "number": "clients phone number",
  "status": "your status id"
 },
 {
  "type": "UPDATE",
  "number": "clients phone number",
  "status": "your status id"
 }
]

Known Response Codes

The response codes to the right can guide you to get your desired results when build on top of our API.

				
					Code : 00000
good job

Code : 00401
The phone number does not exist,
you must first add it

Code : 00402
The status identifier is not valid

Code : 00501
The identifier of the person
in charge is not valid for your use,
check your data.

Code : 00502
the phone number is already in use,
check your data

Code : 00503
The email provided is not valid for use,
check your data.