Creates a new label that can be attached to any content item. Every instance have 3 default labels. Users can add N numbers of labels per instance.
NOTE: Only users with owner or admin roles can create, update and delete a label.
Body: raw JSON
| name | description |
|---|---|
| name | [string] Required. Display name |
| description | [string] A brief description |
| color | [string] Required. Display color |
| allowPublish | [boolean] Required. 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 |
AllowPublish Rule
When it comes to publishing an item, Zesty's labeling workflow for content items have a specific condition in order to limit users on publishing an item. Initially, all instances have 3 labels which allowPublish are set to false. This means that all users can still publish item with or without a label attached to it. As soon as at least 1 label has allowPublish set to true, users will no longer be able to publish items until it has a label with allowPublish=true.
Permissions
Users cannot just attach and remove labels of an item. The addPermissionRoles and removePermissionRoles will contain all role ZUIDs of users that have the permission to add and remove this label from an item. You can have a user that can add a label but they do not have permission to remove it.
Colors
Although the API will not validate the value of the color field, there are only 10 colors the UI will accept.
| name | hex value |
|---|---|
| Blue | #0ba5ec |
| Pink | #ee46bc |
| Purple | #7a5af8 |
| Red | #f04438 |
| Deep Purple | #4e5ba6 |
| Green | #12b76a |
| Yellow | #f79009 |
| Rose | #f63d68 |
| Orange | #ff5c08 |
| Grey | #667085 |