TrackerRMS Help

Your one-stop shop for help on TrackerRMS

Back to Topics

Help Topic: createContact


createContact

POST

/api/widget/createContact

Example of payload of data to the api in order to create or update a contact record within the TrackerRMS database.

Sample Request:

{
      "trackerrms": {
             "createContact": {
                    "credentials": {
                          "username": "my.name@domain.com",
                          "password": "Welcome123",
                          "oauthtoken": "1bc7ca1e-8b9a-11e9-bc42-526af7764f64"
                    },
                    "instructions": {
                          "createcompanyifnotexists": true,
                          "overwritecontact": false
                    },
                    "contact": {
                          "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": "",
                          "cellphone": "888-3465",
                          "email": "john.brown@abcincorp.com",
                          "linkedin": "https://linkedin.com/jbabc/",
                          "website": "",
                          "note": "Lorem ipsum dolor sit amet.",
                          "image": "http://url.to.image"
                    }
             }
      }
}

Sample Response:

{
   "status": 0,
   "message": "success",
   "count": 0
}

Response status codes:

0

success (message will be “created” or “updated”)

1

user not found

2

user not active

3

record found and cannot be overwritten

99

Invalid request