Update an attribute

patch

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

Updates an attribute in the organization.

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 Attributes under the Setup & Administration category when creating or editing an API token. Learn More.

Path Params

string

required

Samsara-provided UUID of the attribute.

Body Params

The attribute to update.

attributeType

string

enum

Defaults to multi-select

Denotes the data type of the attribute's values. Valid values: single-select, multi-select, text, freeform-multi-select, number, date.

Allowed:

entities

array of objects

Entities that will be applied to this attribute

entities

entityType

string

enum

required

Denotes the type of entity, driver or asset.

Allowed:

name

string

Name

numberValues

array of doubles

Number values that can be associated with this attribute

numberValues

stringValues

array of strings

String values that can be associated with this attribute

stringValues

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Newly created attribute object with ID.

defaultError response