TrackerRMS Help

Your one-stop shop for help on TrackerRMS

Back to Topics

Help Topic: createLead


createLead

POST

/api/widget/createLead

Able to payload of data to the api in order to create a lead record within the TrackerRMS database.

Sample Request:

{
      "trackerrms": {
             "createLead": {
                    "credentials": {
                          "username": "my.name@domain.com",
                          "password": "Welcome123",
                          "oauthtoken": "1bc7ca1e-8b9a-11e9-bc42-526af7764f64"
                    },
                    "instructions": {
                          "createpersonifnotexists": true,
                          "notifydepartment": false
                    },
                    "lead": {
                           "leadname": "New Contact Us Submission",
                          "department": "Sales",
                          "source": "Website ",
                          "description": "Lorem ipsum dolor sit amet.",
                          "leadpersontype": "N",
                          "firstname": "John",
                          "lastname": "Brown",
                          "fullname": "John Brown",
                           "jobtitle": "Managing Director",
                          "company": "ABC Incorporated",
                          "address1": "2567 Lexington Avenue",
                          "address2": "",
                          "city": "New York",
                          "state": "NY",
                          "zipcode": "10263",
                          "country": "United States",
                          "businessphone": "555-2387",
                          "homephone": "555-6890",
                          "cellphone": "888-3465",
                          "email": "john.brown@abcincorp.com",
                          "linkedin": "https://linkedin.com/jbabc/",
                          "website": "",
                          "image": ""
                    }
             }
      }
}

Sample Response:

{
   "status": 0,
   "message": "success",
   "count": 0,
   "recordId": 0,
   "recordName": “”
}

Lead Person Types:

N

Contact

R

Resource (Candidate)

Response status codes:

0

Success

1

user not found

2

user not active

99

Invalid request