Create

POST

/tracking/geofence_templates/v1

POST

/tracking/geofence_templates/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.tracking.geofenceTemplates.createV1({
8         geofences: [
9             {
10                 display_name: "display_name",
11                 location: {
12                     geometry: {
13                         coordinates: [],
14                         type: "Point",
15                     },
16                     type: "Feature",
17                 },
18                 radius_miles: 1.1,
19             },
20         ],
21         name: "name",
22         schema_version: 1,
23     });
24 }
25 main();

1 {
2   "_id": "_id",
3   "created_at_timestamp": "2024-01-15T09:30:00Z",
4   "geofences": [
5     {
6       "display_name": "display_name",
7       "location": {
8         "geometry": {
9           "coordinates": [],
10           "type": "Point"
11         },
12         "type": "Feature"
13       },
14       "radius_miles": 1.1
15     }
16   ],
17   "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
18   "name": "name",
19   "owned_by_org_id": "owned_by_org_id",
20   "owned_by_user_id": "owned_by_user_id",
21   "schema_version": 1,
22   "archived_at_timestamp": "2024-01-15T09:30:00Z",
23   "description": "description",
24   "last_used_at_timestamp": "2024-01-15T09:30:00Z"
25 }

Creates a geofence template owned by the caller’s organization. | authz: min_org_role=operator | (SessionGeofenceTemplateClientCreate1) -> (SessionGeofenceTemplate1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

geofenceslist of objectsRequired

namestringRequired>=1 character

schema_versionintegerRequired

descriptionstringOptional

Response

Successful Response

_idstring

created_at_timestampdatetime

geofenceslist of objects

last_edited_at_timestampdatetime

namestring>=1 character

owned_by_org_idstring

Must be a string starting with org_

owned_by_user_idstring

Must be a string starting with user_

schema_versioninteger

archived_at_timestampdatetimeOptional

descriptionstringOptional

last_used_at_timestampdatetimeOptional

Errors

422

Geofence Templates Create V1request Unprocessable Entity Error