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 API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

To use this endpoint, select Write Tags under the Setup & Administration category when creating or editing an API token. Learn More.

POST /tags

Create a tag

cURL

curl --request POST \
  --url https://api.samsara.com/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "California",
  "addresses": [
    "23502866574"
  ],
  "assets": [
    "23502866574"
  ],
  "drivers": [
    "23502866574"
  ],
  "externalIds": {
    "maintenanceId": "250020",
    "payrollId": "ABFS18600"
  },
  "machines": [
    "23502866574"
  ],
  "parentTagId": "4815",
  "sensors": [
    "23502866574"
  ],
  "vehicles": [
    "23502866574"
  ]
}
'

200

{
  "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"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string · required

Name of this tag.

Required string length: 1 - 191

Example:

"California"

addresses · string[]

The addresses that belong to this tag.

The object ID.

assets · string[]

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

The object ID.

drivers · string[]

The drivers that belong to this tag.

The object ID.

externalIds · object

The external IDs for the given object.

Show child attributes

Example:

{
  "maintenanceId": "250020",
  "payrollId": "ABFS18600"
}

machines · string[]

The machines that belong to this tag.

The object ID.

parentTagId · string

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

Example:

"4815"

sensors · string[]

The sensors that belong to this tag.

The object ID.

vehicles · string[]

The vehicles that belong to this tag.

The object ID.

Response

200

application/json

Newly created tag object, including the new tag ID.

A single tag.

data · object

Show child attributes