API Reference

Update Label

put
https://{instance_zuid}.api.zesty.io/v1/env/labels/

Updates a label.

NOTE: Only users with owner or admin roles can create, update and delete a label.

These are the fields that are updatable and each are optional:

Body: raw JSON

namedescription
name[string] Display name
description[string] A brief description
color[string] Display color
sort[int] Swaps sort order of a label with the value given. Should be an existing sort value.
allowPublish[boolean] Determines whether an item can be published or not
addPermissionRoles[array] Role ZUIDs that have the permission to attach this label to an item
removePermissionRoles[array] Role ZUIDs that have the permission to remove this label from an item
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ZUID of the label to update

Body Params

Label object to update

addPermissionRoles
array of strings

Role ZUIDs that have permission to add this label to an item.

addPermissionRoles
boolean
required

AllowPublish is a boolean value that determines if the label can be published.

string
required
string
string
required
removePermissionRoles
array of strings

Role ZUIDs that have permission to remove this label from an item.

removePermissionRoles
integer

Update the sorting order of the label. The sort value should be an existing sort value, a non-zero and not more than the available number of labels.

Responses

Updated 9 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 9 months ago