Skip to main content
Labels help you categorize and organize your reviews. Create labels, assign them to reviews, and use them to filter your content. Labels can also be applied in bulk using the batch_update_reviews tool from the Reviews module.

​
Available Tools

list_labels always returns reviews_count for each label, alongside its id, name, and attributes.css_color_code. There is no include parameter, and the only argument it takes is workspaceId.

​
Identifying Reviews and Labels

Assigning or unassigning labels needs two different kinds of identifier:
  • The review is identified by reviewId (a number) plus feedType (text, audio, video, or social). The id alone is not unique across review types.
  • The labels are passed as reviewLabels, an array of 26-character ULID strings (the id field returned by list_labels), not label names.
assign_labels and unassign_labels take feedType, while the review tools take reviewType. Both accept the same four values. batch_update_reviews uses reviewType and is usually the better choice for tagging several reviews at once.

​
Label Colours

create_label and update_label take a hex colour. The web app’s palette is: Any hex value is accepted, so existing labels may use colours outside this list. list_labels returns each label’s colour as attributes.css_color_code.