TrackerRMS Help

Your one-stop shop for help on TrackerRMS

Back to Topics

Help Topic: updateRecord


updateRecord

POST

/api/widget/updateRecord

Able to send a payload of data to the api to update any record within the TrackerRMS database.

Sample Request:

{
    "trackerrms": {
        "updateRecord": {
            "credentials": {
                "username": "my.name@domain.com",
                "password": "Welcome123",
                "oauthtoken": "1bc7ca1e-8b9a-11e9-bc42-526af7764f64"
            },
            "instructions": {
                "recordtype": "R",
                "recordid": 1234
            },
            "updates": [
                {
                    "column": "firstname",
                    "value": "John"
                },
                {
                    "column": "jobtitle",
                    "value": "Marketing Manager"
                }
            ],
            "customfields": [
                {
                    "id": 123,
                    "value": "Value 1"
                },
                {
                    "id": 456,
                    "value": "Value 2"
                }
            ],
            "skills": [
                {
                    "id": 789,
                    "value": "Yes"
                },
                {
                    "id": 246,
                    "value": "Expert"
                }
            ]
        }
    }
}

Sample Response:

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

 

Column Values:

Please note that columns of type “id” for example resourcestatusid can only be passed integer equivalents.  Please use the /api/widget/getSettings function to retrieve these integer values.

Client Types

If updating Client records, you can update the Client Types values to one or more values by comma separating the Client Types, for example:

                {
                  "column": "clienttype",
                  "value": "Prospect,Gold Client"
                }

Contact Types

If updating Contact records, you can update the Contact Types values to one or more values by comma separating the Contact Types, for example:

                {
                  "column": "contacttype",
                  "value": "Prospect,Top Team"
                }

Placement Statuses

If updating Placement records, you can update the Placement Status values by specifying a numerical id, for example:

                {
                    "column": "opportunityresourcestatusid",
                    "value": "2"
              }

* Be sure to check with the Client Support team for a list of Placement Status IDs

Skills

Skill can be provided for the following records types (will be ignored for all other record types):

C - Clients
N - Contacts
R - Resources/Candidates

Each skill should pass the ID of the skill and the value to set the skill to. 

For Quick Skills, please pass Yes as the value (passing No will clear the quick skill)
For Skill Lists, please pass the text value of the Skill List Value (e.g. Expert)
For Skill Dates, please pass the date in the format YYYY-MM-DD (e.g. 2020-12-31)

 

Record Types:

C

Clients

N

Contacts

L

Leads

O

Opportunities

P

Projects

T

Tickets

R

Resources

X

Placement

 

Response status codes:

0

success

1

user not found

2

user not active

3

record not found

4

column not found

99

Invalid request