Record a rep-initiated device-location check-in for one assigned visit

Checks a fresh phone location against the admin-mapped address for this visit. This is device-reported proximity, not tamper-proof proof of attendance; no background tracking occurs.

POST

https://api.channelautomation.com/api/field-sales/appointments/{id}/checkin

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

id
string
required
format: uuid

Request body JSON required

client_attempt_id
string
required
format: uuid
latitude
number
required
longitude
number
required
accuracy_meters
number
required
captured_at
string
required
format: date-time

Returns

200

Stored verified or unverified result

400

Invalid or stale location sample

403

Feature disabled or visit not assigned to rep

404

Appointment not found in workspace

Record a rep-initiated device-location check-in for one assigned visit

curl --request POST \
  --url 'https://api.channelautomation.com/api/field-sales/appointments/<id>/checkin' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_attempt_id": "83e7d76d-44ca-4bb0-9fdf-8c917c92342d",
  "latitude": 0,
  "longitude": 0,
  "accuracy_meters": 0,
  "captured_at": "2019-08-24T14:15:22Z"
}
'

const url = 'https://api.channelautomation.com/api/field-sales/appointments/<id>/checkin';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    client_attempt_id: '83e7d76d-44ca-4bb0-9fdf-8c917c92342d',
    latitude: 0,
    longitude: 0,
    accuracy_meters: 0,
    captured_at: '2019-08-24T14:15:22Z'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/field-sales/appointments/<id>/checkin"

payload = {
    "client_attempt_id": "83e7d76d-44ca-4bb0-9fdf-8c917c92342d",
    "latitude": 0,
    "longitude": 0,
    "accuracy_meters": 0,
    "captured_at": "2019-08-24T14:15:22Z"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)