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

Request Header

Content-Type : application/json
auth-token : {apikey}

Request Data

{
   "id": 53,//  int 
   "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"
}

Errors

Request Header

Content-Type : application/json
auth-token : {apikey}

Request Data

{
   "term": "Foo",//  string, text based search on the subject, email 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

[
   {
      "id":  53,
      "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

Request Header

auth-token : {apikey}

Response Data

{
   "contactID": 1508,
   "customerID": 3496,
   "accountID": 1515,
   "opportunityID": 1695,   
   "leadID": 4716,
   "success": true
}

Errors

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

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

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

Request Header

Content-Type : application/json
auth-token : {apikey}

Request Data

{
   "customerName": "Company Ltd",//  string(500) 
   "accountName": "Super Account",//  string(500) 
   "productID": 3157,//  int 
   "productPaymentType": "FIXED",//  Can be either FIXED or TNM 
}

Response Data

{
   success : false,
   msg : "INVALID FIRST NAME",
   newid : 186
}

Errors

Request Header

Content-Type : application/json
auth-token : {apikey}

Request Data

{
   "ID": 1735,//  int required
   "name": "website design",//  string(500) 
   "projectmanager": 1086,//  string(500) 
   "status": "ACTIVE",//  string(50), Options: ACTIVE / PENDING / FROZEN / CANCELED / COMPLETED 
   "color": "2",//  int 
   "customFields": {//  object - key:value pairs of the customer's custom fields
      "fieldName1":"fieldValue1",
      "fieldName2":"fieldValue2"
   }
}

Response Data

{
   success : false,
   msg : "INVALID NAME"
}

Errors

Request Header

Content-Type : application/json
auth-token : {apikey}

Request Data

						{
						subject:"subject",//  string(500) 
						description:"description",//  string(5000) 
						name:"name",//  string(500) 
						email:"[email protected]"//  string(250) 
						customFields: {// object - key:value pairs of the account's custom fields
						   "fieldName1":"fieldValue1",
						   "fieldName2":"fieldValue2"
						},
						files:[{
						   data:"image/png;base64,Foo...",
						   contentType:"application/pdf",
						   fileName:"Foo"
						}]
						}
						

Response Data

{
   success : false,
   msg : "INVALID FIRST NAME",
   newid : 186
}

Errors

Request Header

Content-Type : application/json
auth-token : {apikey}

Request Data

{
   "name": "Home Page Design",//  string(500) 
   "description": "Design logo, menu, banner etc...",//  string(500) 
   "estimatedstartdate": "03-25-2017 10:00",//  datetime 
   "estimatedenddate": "03-26-2017 08:00",//  datetime) 
   "deadline": "03-27-2017 12:00",//  datetime 
   "project": 2065,//  int 
   "userid": 1086,//  int 
   "authorid": 1087,//  int required
   "approvedby": 1088//  int 
}

Response Data

{
   success : false,
   msg : "INVALID SUBJECT",
   newid : 186
}

Errors

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