SAsamsara
Tags

Create a tag

Create a new tag for the organization. This may include up to 20,000 tagged entities.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

To use this endpoint, select Write Tags under the Setup & Administration category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

post/tags

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

addressesTaggedObjectId[]

The addresses that belong to this tag.

assetsTaggedObjectId[]

The trailers, unpowered, and powered assets that belong to this tag.

driversTaggedObjectId[]

The drivers that belong to this tag.

externalIdsobject

The external IDs for the given object.

machinesTaggedObjectId[]

The machines that belong to this tag.

namestring required

Name of this tag.

parentTagIdstring

If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.

sensorsTaggedObjectId[]

The sensors that belong to this tag.

vehiclesTaggedObjectId[]

The vehicles that belong to this tag.

Example request

{
  "addresses": [
    "23502866574"
  ],
  "assets": [
    "23502866574"
  ],
  "drivers": [
    "23502866574"
  ],
  "externalIds": {
    "maintenanceId": "250020",
    "payrollId": "ABFS18600"
  },
  "machines": [
    "23502866574"
  ],
  "name": "California",
  "parentTagId": "4815",
  "sensors": [
    "23502866574"
  ],
  "vehicles": [
    "23502866574"
  ]
}

Response

Newly created tag object, including the new tag ID.

Example response

{
  "data": {
    "id": "342417",
    "name": "California",
    "parentTagId": "4815",
    "addresses": [
      {
        "id": "23502866574",
        "name": "Driver Don"
      }
    ],
    "assets": [
      {
        "id": "23502866574",
        "name": "Driver Don"
      }
    ],
    "drivers": [
      {
        "id": "23502866574",
        "name": "Driver Don"
      }
    ],
    "externalIds": {
      "maintenanceId": "250020",
      "payrollId": "ABFS18600"
    },
    "machines": [
      {
        "id": "23502866574",
        "name": "Driver Don"
      }
    ],
    "parentTag": {
      "id": "23502866574",
      "name": "US West Vehicles"
    },
    "sensors": [
      {
        "id": "23502866574",
        "name": "Driver Don"
      }
    ],
    "vehicles": [
      {
        "id": "23502866574",
        "name": "Driver Don"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.