Tags are simple labels that can be attached to Events or ItemSets. Tags are especially useful as filters when creating Views.
Create a Tag
Creates a Tag based on the provided fields.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationto which thisTagbelongs.namestring · requiredDisplay name of the
Tag.colorstring · hex · requiredA color hex code string without the leading
#.symbolinteger · requiredThe visual symbol representing this
Tag.Value Name 0 CLIPBOARD 1 BROOM 2 CAMERA 3 CAR 4 HAMMER 5 HEADSET 6 KEY 7 LADDER 8 LAPTOP 9 LIGHTBULB 10 MONITOR 11 PLUG 12 STOOL 13 TRUCK 14 VIDEO_CAMERA 15 WRENCH 16 COFFEE 17 COOKIE 18 PEPPER 19 FLOWER 20 DROP 21 MOON 22 RAINBOW 23 SUN 24 EAR 25 EYE 26 FACE_MASK 27 PERSON 28 SMILEY 29 WHEELCHAIR 30 SWORD 31 COAT_HANGER 32 DRESS 33 CROWN 34 HIGH_HEEL 35 PANTS 36 SNEAKER 37 CHAMPAGNE 38 GRADUATION_CAP 39 CASTLE_TURRET 40 HOUSE 41 PAINT_BUCKET 42 FILM_SLATE 43 HANDS_CLAPPING 44 MAGIC_WAND 45 MASK_HAPPY 46 MASK_SAD 47 TICKET 48 MICROPHONE_STAGE 49 MUSIC_NOTES 50 SPEAKER_HIFI 51 MONEY 52 CIRCLES_THREE 53 ASTERISK 54 HEXAGON 55 CLUB 56 DIAMOND 57 HEART 58 LIGHTNING 59 SPADE 60 SPARKLE 61 STAR 62 TRIANGLE 63 CLOCK 64 FLAG 65 GLOBE 66 BOOK 67 MEGAPHONE 68 TAG 69 WARNING allowOnobject · requiredControls what type of entity a
Tagcan be associated with.
Responses
The newly created Tag.
tagobject
Update a Tag
Updates the specified Tag by setting the values of the fields passed.
Any fields not provided will remain unchanged. By design, you cannot change a Tag’s id.
path Parameters
tagIdstring · uuid · requiredThe id of the
Tag.
Request Body
namestringDisplay name of the
Tag.colorstring · hexA color hex code string without the leading
#.symbolintegerThe visual symbol representing this
Tag.Value Name 0 CLIPBOARD 1 BROOM 2 CAMERA 3 CAR 4 HAMMER 5 HEADSET 6 KEY 7 LADDER 8 LAPTOP 9 LIGHTBULB 10 MONITOR 11 PLUG 12 STOOL 13 TRUCK 14 VIDEO_CAMERA 15 WRENCH 16 COFFEE 17 COOKIE 18 PEPPER 19 FLOWER 20 DROP 21 MOON 22 RAINBOW 23 SUN 24 EAR 25 EYE 26 FACE_MASK 27 PERSON 28 SMILEY 29 WHEELCHAIR 30 SWORD 31 COAT_HANGER 32 DRESS 33 CROWN 34 HIGH_HEEL 35 PANTS 36 SNEAKER 37 CHAMPAGNE 38 GRADUATION_CAP 39 CASTLE_TURRET 40 HOUSE 41 PAINT_BUCKET 42 FILM_SLATE 43 HANDS_CLAPPING 44 MAGIC_WAND 45 MASK_HAPPY 46 MASK_SAD 47 TICKET 48 MICROPHONE_STAGE 49 MUSIC_NOTES 50 SPEAKER_HIFI 51 MONEY 52 CIRCLES_THREE 53 ASTERISK 54 HEXAGON 55 CLUB 56 DIAMOND 57 HEART 58 LIGHTNING 59 SPADE 60 SPARKLE 61 STAR 62 TRIANGLE 63 CLOCK 64 FLAG 65 GLOBE 66 BOOK 67 MEGAPHONE 68 TAG 69 WARNING allowOnobjectControls what type of entity a
Tagcan be associated with.
Responses
The updated Tag.
tagobject