Location
End-user coordinates and associated location metadata.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
latitude | number (double) or string (NaN, Infinity, -Infinity) | Optional | Latitude of the location in decimal degrees. |
longitude | number (double) or string (NaN, Infinity, -Infinity) | Optional | Longitude of the location in decimal degrees. |
city | string | Optional | City associated with the location; currently left empty because reverse geocoding is not implemented. |
timezone | string | Optional | IANA time zone associated with the record or schedule. IANA, derived from coordinates server-side. |
updatedAt | string (date-time) | Optional | Time this record was most recently updated. |
Where used
| Reference | Relationship |
|---|---|
| Get the caller's end-user profile | POST /api/v1/enduser/get |
| Update the caller's location | POST /api/v1/enduser/update-location |
| EndUserState | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-location.