Update a tag

patch

https://api.samsara.com/tags/{id}

Update an existing tag. Note this implementation of patch uses the JSON merge patch proposed standard.

This means that any fields included in the patch request will overwrite fields which exist on the target resource.

For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array.

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.

Path Params

string

required

ID of the Tag. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: key:value. For example, crmId:abc123. Automatically populated external IDs are prefixed with samsara.. For example, samsara.name:ELD-exempt.

Body Params

addresses

array of objects

The addresses that belong to this tag.

addresses

assets

array of objects

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

assets

drivers

array of objects

The drivers that belong to this tag.

drivers

externalIds

object

The external IDs for the given object.

machines

array of objects

The machines that belong to this tag.

machines

name

string

length between 1 and 191

Name of this tag.

parentTagId

string

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

sensors

array of objects

The sensors that belong to this tag.

sensors

vehicles

array of objects

The vehicles that belong to this tag.

vehicles

Responses

200Returns updated tag object.

defaultError response