API Payload Examples

Lead Capture - Add/Update Contacts

Endpoint: https://serviceminder.io/api/contacts/addupdate

Example payload:

{
    "Matches": [{
        "Name": "Testing SM",
        "Phone": "785-555-5555",
        "Zip": "12345",
        "Email": "testinghere@test.com"
    }],
    "ApiKey": "your-api-key",
    "ResultCode": "",
    "Message": ""
}

Add custom fields:

{
    "Matches": [{
        "Name": "Testing SM",
        "Phone": "785-555-5555",
        "Zip": "12345",
        "Email": "testinghere@test.com",
        "CustomFields": [{
            "Name":"Lot Size",
            "Value": "275"
        },
        {
            "Name":"Spray Time",
            "Value": "2"
        }]
    }],
    "ApiKey": "your-api-key",
    "ResultCode": "",
    "Message": ""
}

A lot of information can be passed to serviceminder using this method for contacts. The full list is here.

Locate Contacts

Endpoint: https://serviceminder.io/api/contacts/locate

{
    "ApiKey": "your-api-key",
    "NameSearch": "Jim Jimmy",
    "Matches": []
}

Leave Feedback

Note that the Feedback API requires the organization to have the feature "Feedback+Issues" add-on.

Endpoint: https://serviceminder.io/api/appointments/feedback

Leaving Feedback w/ no Follow-up Requested

{
  "ApiKey": "your-api-key",
  "HashKey": "appointment-hash-key or use the Id property",
  "Id": 123,
  "Note": "thanks for awesome service",
  "ContactMe": false,
  "Score": 5
}

Leaving Feedback With an Issue for Follow-up

{
  "ApiKey": "your-api-key",
  "HashKey": "appointment-hash-key or use the Id property",
  "Id": 123,
  "Note": "wow... not in a good way",
  "ContactMe": true,
  "Score": 1
}

Request Follow-up Without a Rating

{
  "ApiKey": "your-api-key",
  "HashKey": "appointment-hash-key or use the Id property",
  "Id": 123,
  "Note": "wow... not in a good way",
  "ContactMe": true,
}