DEVELOPERS / API Docs v1

End of API Key

API Key

Using Manavte's API requires API Key.
To get your API Key and Account Name, you must have an active account.
Go to Settings > General
URL Access
https://{accountName}.manavate.com/api
Don't forget to turn on the option Allow API on the same page.
IMPORTANT - DO NOT SEND THE API KEY FROM THE CLIENT
End of Leads

Leads

/leads/create POST

Request Header
Content-Type : application/json
auth-token : {apikey}
Request Data
{
   "firstname": "Jimi",//  string(50) 
   "lastname": "Ganja",//  string(50) 
   "company": "Digital Company Ltd",//  string(50) 
   "email": "[email protected]",//  string(250) 
   "phone": "972501234567",//  string(50) 
   "cell": "972501234567",//  string(50) 
   "fax": "972501234567",//  string(50) 
   "address": "address",//  string(50) 
   "subject": "Price Offer",//  string(500) 
   "content": "Hello...",//  string 
   "userid": 2851,//  int 
   "asset": "Landing Page",//  string(500), adds new entry if the asset is new 
   "source": "Google",//  string(500), adds new entry if the source is new  
   "campaign": "New Year 2005",//  string(500), adds new entry if the campaign is new 
   "medium": "Sponsored",//  string(500), adds new entry if the medium is new  
   "labels": ["label1","label2"],//  array, adds new entries if the labels are new 
   "customFields": {//  object - key:value pairs of the account's custom fields
      "fieldName1":"fieldValue1",
      "fieldName2":"fieldValue2"    } }
Response Data
{
   success : false,
   msg : "INVALID FIRST NAME",
   newid : 186
}
Errors
Error Massage Description
VALIDATION ERROR One or more of the given fields are not of the right type or length
INVALID TOKEN The recieved token is incorrect.
INVALID DATA The given json data is empty
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.
MISSING CUSTOM FIELD One or more custom fields keys are not exist.
INVALID CUSTOM FIELD VALUE One or more custom fields valus are not matched (on type dropdown only).

/leads/update POST

Coming Soon..

/leads/delete POST

Coming Soon..

/leads/get GET

Request Header
Content-Type : application/json
auth-token : {apikey}
Request Data
{
   "term": "Foo",//  string, text based search on the subject and content fields
   "source": 7,//  number, optional, the id field that you get from LeadSources/get
   "campaign": 3,//  number, optional, the id field that you get from Campaigns/get 
   "asset": 5,//  number, optional, the id field that you get from Assets/get 
   "medium": 9//  number, optional, the id field that you get from Media/get 
}
Response Data
[
   {
      "fullname":  "Jimi Ganja",
      "company": "Digital Company Ltd",       "email": "[email protected]",
      "phone": "972501234567",       "cell": "972501234567",
      "fax": "97231234567",       "address": "Somewhere Out There",
      "subject": "Price Offer",       "content": "Hello...",
      "createdate": "16/12/2005",       "asset": "Landing Page",
      "source": "Google",       "campaign": "New Year 2005",
      "medium": "Sponsored"
   },
   {...} ]
Errors
Error Massage Description
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.

/leads/convert/:leadid: POST

Request Header
auth-token : {apikey}
Response Data
{
   "contactID": 1508,
   "customerID": 3496,
   "accountID": 1515,
   "opportunityID": 1695,   
   "leadID": 4716,
   "success": true
}
Errors
Error Massage Description
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.
End of Assets

Assets

/assets/create POST

Coming Soon..

/assets/update POST

Coming Soon..

/assets/delete POST

Coming Soon..

/assets/get POST

Coming Soon..
End of Campaigns

Campaigns

/campaigns/create POST

Coming Soon..

/campaigns/update POST

Coming Soon..

/campaigns/delete POST

Coming Soon..

/campaigns/get POST

Coming Soon..
End of Sources

Sources

/sources/create POST

Coming Soon..

/sources/update POST

Coming Soon..

/sources/delete POST

Coming Soon..

/sources/get POST

Coming Soon..
End of Media

Media

/media/create POST

Coming Soon..

/media/update POST

Coming Soon..

/media/delete POST

Coming Soon..

/media/get POST

Coming Soon..
End of Opportunities

Opportunities

/opportunities/create POST

Coming Soon..

/opportunities/update POST

Coming Soon..

/opportunities/delete POST

Coming Soon..

/opportunities/get POST

Coming Soon..
End of Customers

Cusromers

/cusromers/create POST

Request Header
Content-Type : application/json
auth-token : {apikey}
Request Data
{
   "companyName": "Digital Company Ltd",//  string(500) required
   "address": "137th North st, new york, NY",//  string(1000) 
   "companyID": "12345678",//  string(50) 
   "email": "[email protected]",//  string(250) 
   "phone": "972501234567",//  string(50) 
   "fax": "972501234567",//  string(50) 
   "signed": true,//  boolean 
   "mainContact": {//  object - key:value
      "firstName":"Jimi",//  string(500) required if mainContact is added
      "lastName":"Ganja",// string(500)
      "phone":"972501234567",// string(50)
      "cell":"972501234567",// string(50)
      "email":"[email protected]",// string(200)
      "title":"CEO"// string(500)    },    "customFields": {// object - key:value pairs of the customer's custom fields       "fieldName1":"fieldValue1",
      "fieldName2":"fieldValue2"    } }
Response Data
{
   success : false,
   msg : "INVALID FIRST NAME",
   newid : 186
}
Errors
Error Massage Description
VALIDATION ERROR One or more of the given fields are not of the right type or length
INVALID TOKEN The recieved token is incorrect.
INVALID DATA The given json data is empty
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.
MISSING CUSTOM FIELD One or more custom fields keys are not exist.
INVALID CUSTOM FIELD VALUE One or more custom fields valus are not matched (on type dropdown only).

/cusromers/update POST

Request Header
Content-Type : application/json
auth-token : {apikey}
Request Data
{
   "ID": 1735,//  int required
   "companyName": "Digital Company Ltd",//  string(500) 
   "address": "137th North st, new york, NY",//  string(1000) 
   "companyID": "12345678",//  string(50) 
   "email": "[email protected]",//  string(250) 
   "phone": "972501234567",//  string(50) 
   "fax": "972501234567",//  string(50) 
   "signed": true,//  boolean 
   "customFields": {//  object - key:value pairs of the customer's custom fields
      "fieldName1":"fieldValue1",
      "fieldName2":"fieldValue2"    } }
Response Data
{
   success : false,
   msg : "INVALID FIRST NAME"
}
Errors
Error Massage Description
VALIDATION ERROR One or more of the given fields are not of the right type or length
INVALID TOKEN The recieved token is incorrect.
INVALID DATA The given json data is empty
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.
MISSING CUSTOM FIELD One or more custom fields keys are not exist.
INVALID CUSTOM FIELD VALUE One or more custom fields valus are not matched (on type dropdown only).

/cusromers/delete POST

Coming Soon..

/cusromers/get GET

Request Header
Content-Type : application/json
auth-token : {apikey}
Request Data
"term": "Foo",//  string, text based search on the name and contact name fields
Response Data
[
   {
      "ID":  1735,
      "creatDate": "2020-12-06T12:36:02.957Z",       "companyName": "Digital Company Ltd",
      "address": "137th North st, new york, NY",       "companyID": "12345678",
      "signed": true,       "phone": "97231234567",
      "fax": "97231234567",       "email": "[email protected]",
      "signedSince": "2020-12-06T12:36:02.957Z"       "mainContact": {          "firstName":"Jimi",
         "lastName":"Ganja",
         "phone":"972501234567",
         "cell":"972501234567",
         "email":"[email protected]",
         "title":"CEO"       }
   },
   {...} ]
Errors
Error Massage Description
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.
End of Accounts

Accounts

/accounts/create POST

Coming Soon..

/accounts/update POST

Coming Soon..

/accounts/delete POST

Coming Soon..

/accounts/get POST

Coming Soon..
End of Contacts

Contacts

/contacts/create POST

Coming Soon..

/contacts/update POST

Coming Soon..

/contacts/delete POST

Coming Soon..

/contacts/get POST

Coming Soon..
End of Projects / Services

Projects / Services

/projects/create POST

Coming Soon..

/projects/update POST

Coming Soon..

/projects/delete POST

Coming Soon..

/projects/get POST

Coming Soon..
End of Tickets

Tickets

/tickets/create POST

Request Header
Content-Type : application/json
APIKey : {apikey}
Request Data
{ 
   subject: "subject",// string(500)
   description: "description",// string(5000)
   name: "name",// string(500)
   email: "[email protected]",// string(250)
}
Response Data
{
   success : false,
   msg : "INVALID FIRST NAME",
   newid : 186
}
Errors
Error Massage Description
VALIDATION_ERROR One or more of the given fields are not of the right type or length
INVALID TOKEN The recieved token is incorrect.
INVALID DATA The given json data is empty
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.

/tickets/update POST

Coming Soon..

/tickets/delete POST

Coming Soon..

/tickets/get POST

Coming Soon..
End of Tasks

Tasks

/tasks/create POST

Coming Soon..

/tasks/update POST

Coming Soon..

/tasks/delete POST

Coming Soon..

/tasks/get POST

Coming Soon..
End of Files

Files

/files/create POST

Request Header
Content-Type : application/json
auth-token : {apikey}
Request Data
{
   "customerID": 1735,//  int required if projectID is not exist
   "projectID": 5371,//  int required if customerID is not exist
   "description": "Product description",//  string(500) required
   "filePath": "https://drive.website.com/foo/file.jpg",//  string(500) required if file is not exist
   "file": "data:image/png;base64,Foo...",//  base64 required if filePath is not exist
}
Response Data
{
   success : false,
   msg : "INVALID FILE",
   newid : 186
}
Errors
Error Massage Description
VALIDATION ERROR One or more of the given fields are not of the right type or length
INVALID TOKEN The recieved token is incorrect.
INVALID DATA The given json data is empty
API ACCESS NOT ALLOWED FOR THIS ACCOUNT The account is not set to recieve API access. To allow access, check the Allow Api checkbox on the system's general settings tab.
MISSING CUSTOM FIELD One or more custom fields keys are not exist.
INVALID CUSTOM FIELD VALUE One or more custom fields valus are not matched (on type dropdown only).

/files/update POST

Coming Soon..

/files/delete POST

Coming Soon..

/files/get POST

Coming Soon..
End of Payments

Payments

/payments/create POST

Coming Soon..

/payments/update POST

Coming Soon..

/payments/delete POST

Coming Soon..

/payments/get POST

Coming Soon..
End of Departments

Departments

/departments/create POST

Coming Soon..

/departments/update POST

Coming Soon..

/departments/delete POST

Coming Soon..

/departments/get POST

Coming Soon..
End of Products

Products

/products/create POST

Coming Soon..

/products/update POST

Coming Soon..

/products/delete POST

Coming Soon..

/products/get POST

Coming Soon..
Try Manavate for your business

14-day free trial | No credit card needed

Get Started