Update

PATCH

/tracking/geofence_templates/update/v1/:geofence_template_id

PATCH

/tracking/geofence_templates/update/v1/:geofence_template_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.tracking.geofenceTemplates.updateV1("geofence_template_id", {});
}
main();

{
  "_id": "_id",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "geofences": [
    {
      "display_name": "display_name",
      "location": {
        "geometry": {
          "coordinates": [],
          "type": "Point"
        },
        "type": "Feature"
      },
      "radius_miles": 1.1
    }
  ],
  "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
  "name": "name",
  "owned_by_org_id": "owned_by_org_id",
  "owned_by_user_id": "owned_by_user_id",
  "schema_version": 1,
  "archived_at_timestamp": "2024-01-15T09:30:00Z",
  "description": "description",
  "last_used_at_timestamp": "2024-01-15T09:30:00Z"
}

Updates an active geofence template owned by the caller’s organization. | authz: min_org_role=operator | (SessionGeofenceTemplateClientUpdate1) -> (SessionGeofenceTemplate1)

Authentication

AuthorizationBearer

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

Path parameters

geofence_template_idstringRequired

Request

This endpoint expects an object.

descriptionstringOptional

description__set_to_NonebooleanOptionalDefaults to false

geofenceslist of objectsOptional

namestringOptional>=1 character

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 Update V1request Unprocessable Entity Error