Skip to main content
PUT
Update Location Tag

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the LocationTag.

Required range: x >= 1

Body

application/json
name
string

The display name of the tag. HTML tags are stripped and surrounding whitespace is trimmed. The limit is short of the field's own 255 characters because the rest is reserved for the suffix the name carries once the tag is deleted.

Required string length: 1 - 230
Example:

"Hazmat"

description
string | null

An explanation of what the tag signifies.

Maximum string length: 255
Example:

"Locations approved to store hazardous materials."

color
enum<string>

The palette entry the tag renders with, written as a color family followed by a shade from 1 (lightest) to 5 (darkest).

Available options:
black1,
black2,
black3,
black4,
black5,
blue1,
blue2,
blue3,
blue4,
blue5,
brown1,
brown2,
brown3,
brown4,
brown5,
gray1,
gray2,
gray3,
gray4,
gray5,
green1,
green2,
green3,
green4,
green5,
orange1,
orange2,
orange3,
orange4,
orange5,
purple1,
purple2,
purple3,
purple4,
purple5,
red1,
red2,
red3,
red4,
red5,
yellow1,
yellow2,
yellow3,
yellow4,
yellow5
Example:

"blue3"

sort_order
integer

The position the tag takes when tags are listed for selection.

Required range: -2147483648 <= x <= 2147483647
Example:

3

is_deleted
boolean

Set to false to restore a soft-deleted tag, or true to soft-delete it.

Example:

false

Response

OK - The operation completed successfully and there is no response body.