Roles represent characters, crew positions, creative team members, and other roles within a Project. You can assign People to Roles to automatically call that Person whenever you assign a Role to an Event (including retroactively).
RoleGroups represent groups of Roles that you can use to assign multiple Roles to an Event at once, like "Scene III" or "Creative Team".
Create a Role
Creates a Role based on the provided fields.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisRole.namestring · requiredThe name of the
Role.colorstring · requiredHex color code (without #).
symbolinteger · enum · requiredThe symbol icon for a
RoleorRoleGroup.Value Name 0 ALIEN 1 BABY 2 DETECTIVE 3 GHOST 4 MASK_HAPPY 5 MASK_SAD 6 SKULL 7 ROBOT 8 BASEBALL_CAP 9 CHEF_HAT 10 COWBOY_HAT 11 CROWN 12 FOOTBALL_HELMET 13 GRADUATION_CAP 14 HARD_HAT 15 HANDSHAKE 16 PERSON 17 KNIFE 18 MAGIC_WAND 19 SWORD 20 TROPHY 21 BACKPACK 22 COAT_HANGER 23 DRESS 24 EYEGLASSES 25 HAIR_DRYER 26 HIGH_HEEL 27 BOOK_OPEN_TEXT 28 CAMERA 29 CLIPBOARD 30 FILM_SLATE 31 HEADSET 32 MEGAPHONE 33 OFFICE_CHAIR 34 PEN_NIB 35 STAR 36 VIDEO_CAMERA 37 BLUEPRINT 38 HAMMER 39 LADDER 40 PAINT_BRUSH 41 WRENCH 42 BEER_STEIN 43 BOWL_STEAM 44 CARROT 45 COFFEE 46 COOKIE 47 FORK_KNIFE 48 ORANGE_SLICE 49 WINE 50 EQUALIZER 51 GUITAR 52 MICROPHONE_STAGE 53 MUSIC_NOTES 54 PIANO_KEYS 55 SPEAKER_HIFI 56 BROOM 57 BUILDING 58 CAR 59 KEY 60 CALL_BELL 61 CONFETTI 62 MONEY 63 PHONE 64 SHIELD_STAR 65 TICKET 66 TRAFFIC_CONE 67 LIGHTBULB 68 PLUG 69 LAPTOP Enum values:01234567pricesobject · requiredA map of
PriceTierids to prices.
projectIdstring · uuidIf applicable, the id of the
ProjectthisRolebelongs to. Absent if theRoleisOrganization-wide.personIdstring · uuidIf applicable, the id of the
Personassigned to thisRole. Absent if noPersonis assigned.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The newly created Role.
roleobject
Delete a Role
Deletes the specified Role.
By default, deleting a Role does not remove the associated Person from future associated Events (though the Role itself is removed from associated Events). To remove the Person from future associated Events, set the remove_person parameter to true.
path Parameters
roleIdstring · uuid · requiredThe id of the
Role.
query Parameters
remove_personbooleanIf
true, thePersonassociated with theRolewill be removed from future associatedEvents.Default: false
Responses
The Role was successfully deleted.
Update a Role
Updates the specified Role by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a Role's id or the Project it belongs to.
If the associated Person is removed or updated, the former Person will be removed from future associated Events. If a new Person is associated, they will be added to future associated Events.
path Parameters
roleIdstring · uuid · requiredThe id of the
Role.
Request Body
namestringThe name of the
Role.colorstringHex color code (without #).
personIdstring · uuidIf applicable, the id of the
Personassigned to thisRole. To unset this field, setremovePersonIdtotrue.removePersonIdbooleanIf
true, removes the assignedPersonfrom thisRole.symbolinteger · enumThe symbol icon for a
RoleorRoleGroup.Value Name 0 ALIEN 1 BABY 2 DETECTIVE 3 GHOST 4 MASK_HAPPY 5 MASK_SAD 6 SKULL 7 ROBOT 8 BASEBALL_CAP 9 CHEF_HAT 10 COWBOY_HAT 11 CROWN 12 FOOTBALL_HELMET 13 GRADUATION_CAP 14 HARD_HAT 15 HANDSHAKE 16 PERSON 17 KNIFE 18 MAGIC_WAND 19 SWORD 20 TROPHY 21 BACKPACK 22 COAT_HANGER 23 DRESS 24 EYEGLASSES 25 HAIR_DRYER 26 HIGH_HEEL 27 BOOK_OPEN_TEXT 28 CAMERA 29 CLIPBOARD 30 FILM_SLATE 31 HEADSET 32 MEGAPHONE 33 OFFICE_CHAIR 34 PEN_NIB 35 STAR 36 VIDEO_CAMERA 37 BLUEPRINT 38 HAMMER 39 LADDER 40 PAINT_BRUSH 41 WRENCH 42 BEER_STEIN 43 BOWL_STEAM 44 CARROT 45 COFFEE 46 COOKIE 47 FORK_KNIFE 48 ORANGE_SLICE 49 WINE 50 EQUALIZER 51 GUITAR 52 MICROPHONE_STAGE 53 MUSIC_NOTES 54 PIANO_KEYS 55 SPEAKER_HIFI 56 BROOM 57 BUILDING 58 CAR 59 KEY 60 CALL_BELL 61 CONFETTI 62 MONEY 63 PHONE 64 SHIELD_STAR 65 TICKET 66 TRAFFIC_CONE 67 LIGHTBULB 68 PLUG 69 LAPTOP Enum values:01234567detailsstring · htmlSupports basic HTML tags and formatting.
pricesobjectA map of
PriceTierids to prices.
Responses
The updated Role.
roleobject
Create a RoleGroup
Creates a RoleGroup based on the provided fields.
Request Body
orgIdstring · uuid · readOnly · requiredThe id of the
Organizationthat owns thisRoleGroup.namestring · requiredThe name of the
RoleGroup.colorstring · requiredHex color code (without #).
symbolinteger · enum · requiredThe symbol icon for a
RoleorRoleGroup.Value Name 0 ALIEN 1 BABY 2 DETECTIVE 3 GHOST 4 MASK_HAPPY 5 MASK_SAD 6 SKULL 7 ROBOT 8 BASEBALL_CAP 9 CHEF_HAT 10 COWBOY_HAT 11 CROWN 12 FOOTBALL_HELMET 13 GRADUATION_CAP 14 HARD_HAT 15 HANDSHAKE 16 PERSON 17 KNIFE 18 MAGIC_WAND 19 SWORD 20 TROPHY 21 BACKPACK 22 COAT_HANGER 23 DRESS 24 EYEGLASSES 25 HAIR_DRYER 26 HIGH_HEEL 27 BOOK_OPEN_TEXT 28 CAMERA 29 CLIPBOARD 30 FILM_SLATE 31 HEADSET 32 MEGAPHONE 33 OFFICE_CHAIR 34 PEN_NIB 35 STAR 36 VIDEO_CAMERA 37 BLUEPRINT 38 HAMMER 39 LADDER 40 PAINT_BRUSH 41 WRENCH 42 BEER_STEIN 43 BOWL_STEAM 44 CARROT 45 COFFEE 46 COOKIE 47 FORK_KNIFE 48 ORANGE_SLICE 49 WINE 50 EQUALIZER 51 GUITAR 52 MICROPHONE_STAGE 53 MUSIC_NOTES 54 PIANO_KEYS 55 SPEAKER_HIFI 56 BROOM 57 BUILDING 58 CAR 59 KEY 60 CALL_BELL 61 CONFETTI 62 MONEY 63 PHONE 64 SHIELD_STAR 65 TICKET 66 TRAFFIC_CONE 67 LIGHTBULB 68 PLUG 69 LAPTOP Enum values:01234567roleIdsstring[] · requiredThe ids of the
Rolesin thisRoleGroup.
projectIdstring · uuidIf applicable, the id of the
ProjectthisRoleGroupbelongs to. Absent if theRoleGroupisOrganization-wide.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The newly created RoleGroup.
roleGroupobject
Update a RoleGroup
Updates the specified RoleGroup by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a RoleGroup's id or the Project it belongs to.
Deleting a RoleGroup does not remove any of its Roles from associated Events (though the RoleGroup itself is removed from associated Events).
path Parameters
roleGroupIdstring · uuid · requiredThe id of the
RoleGroup.
Request Body
namestringThe name of the
RoleGroup.colorstringHex color code (without #).
symbolinteger · enumThe symbol icon for a
RoleorRoleGroup.Value Name 0 ALIEN 1 BABY 2 DETECTIVE 3 GHOST 4 MASK_HAPPY 5 MASK_SAD 6 SKULL 7 ROBOT 8 BASEBALL_CAP 9 CHEF_HAT 10 COWBOY_HAT 11 CROWN 12 FOOTBALL_HELMET 13 GRADUATION_CAP 14 HARD_HAT 15 HANDSHAKE 16 PERSON 17 KNIFE 18 MAGIC_WAND 19 SWORD 20 TROPHY 21 BACKPACK 22 COAT_HANGER 23 DRESS 24 EYEGLASSES 25 HAIR_DRYER 26 HIGH_HEEL 27 BOOK_OPEN_TEXT 28 CAMERA 29 CLIPBOARD 30 FILM_SLATE 31 HEADSET 32 MEGAPHONE 33 OFFICE_CHAIR 34 PEN_NIB 35 STAR 36 VIDEO_CAMERA 37 BLUEPRINT 38 HAMMER 39 LADDER 40 PAINT_BRUSH 41 WRENCH 42 BEER_STEIN 43 BOWL_STEAM 44 CARROT 45 COFFEE 46 COOKIE 47 FORK_KNIFE 48 ORANGE_SLICE 49 WINE 50 EQUALIZER 51 GUITAR 52 MICROPHONE_STAGE 53 MUSIC_NOTES 54 PIANO_KEYS 55 SPEAKER_HIFI 56 BROOM 57 BUILDING 58 CAR 59 KEY 60 CALL_BELL 61 CONFETTI 62 MONEY 63 PHONE 64 SHIELD_STAR 65 TICKET 66 TRAFFIC_CONE 67 LIGHTBULB 68 PLUG 69 LAPTOP Enum values:01234567roleIdsstring[]The ids of the
Rolesin thisRoleGroup.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The updated RoleGroup.
roleGroupobject