Consumables are reusable or expendable materials used in productions or operations, like food, drinks, cleaning supplies, gaffer's tape, and other supplies.
Create a Consumable
Creates a Consumable based on the provided fields.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisConsumable.namestring · requiredcolorstring · requiredHex color code (without the
#symbol).symbolinteger · requiredThe visual symbol representing this
Consumable.Value Symbol 0 COFFEE_BEAN 1 COOKIE 2 BEER_STEIN 3 BOWL_STEAM 4 CARROT 5 ORANGE_SLICE 6 BEER_BOTTLE 7 BOWL_FOOD 8 HAMBURGER 9 PIZZA 10 PEPPER 11 DROP 12 WINE 13 FORK_KNIFE 14 AVOCADO 15 BRANDY 16 COFFEE 17 ONIGIRI 18 SHRIMP 19 ACORN 20 BREAD 21 CHEESE 22 CHERRIES 23 COOKING_POT 24 EGG 25 FISH 26 ICE_CREAM 27 DISCO_BALL 28 CHAMPAGNE 29 CALL_BELL 30 CONFETTI 31 TICKET 32 BALLOON 33 HIGH_HEEL 34 PANTS 35 SNEAKER 36 BASEBALL_CAP 37 BAG 38 BICYCLE 39 FACE_MASK 40 BANDAIDS_FILL 41 ARMCHAIR 42 CHAIR 43 BROOM 44 POTTED_PLANT 45 BASKET 46 LADDER 47 FAN 48 LIGHTBULB 49 KNIFE 50 LIGHTNING 51 BLUEPRINT 52 HAMMER 53 PAINT_ROLLER 54 PAINT_BRUSH 55 BOOK_OPEN_TEXT 56 PEN_NIB 57 PALETTE 58 CLIPBOARD 59 PIANO_KEYS 60 SPEAKER_HIFI 61 BOOK 62 PAPERCLIP 63 PAINT_BUCKET 64 GUITAR 65 MICROPHONE_STAGE 66 GAME_CONTROLLER 67 PENCIL 68 APERTURE 69 BATTERY_FULL pricesobject · requiredA map of
PriceTierids to prices.
coverPhotoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The newly created Consumable.
consumableobject
Update a Consumable
Updates the specified Consumable by setting the values of the fields passed. Any fields not provided will remain unchanged. By design, you cannot change a Consumable's id.
path Parameters
consumableIdstring · uuid · requiredThe id of the
Consumable.
Request Body
namestringcolorstringHex color code (without the
#symbol).symbolintegerThe visual symbol representing this
Consumable.Value Symbol 0 COFFEE_BEAN 1 COOKIE 2 BEER_STEIN 3 BOWL_STEAM 4 CARROT 5 ORANGE_SLICE 6 BEER_BOTTLE 7 BOWL_FOOD 8 HAMBURGER 9 PIZZA 10 PEPPER 11 DROP 12 WINE 13 FORK_KNIFE 14 AVOCADO 15 BRANDY 16 COFFEE 17 ONIGIRI 18 SHRIMP 19 ACORN 20 BREAD 21 CHEESE 22 CHERRIES 23 COOKING_POT 24 EGG 25 FISH 26 ICE_CREAM 27 DISCO_BALL 28 CHAMPAGNE 29 CALL_BELL 30 CONFETTI 31 TICKET 32 BALLOON 33 HIGH_HEEL 34 PANTS 35 SNEAKER 36 BASEBALL_CAP 37 BAG 38 BICYCLE 39 FACE_MASK 40 BANDAIDS_FILL 41 ARMCHAIR 42 CHAIR 43 BROOM 44 POTTED_PLANT 45 BASKET 46 LADDER 47 FAN 48 LIGHTBULB 49 KNIFE 50 LIGHTNING 51 BLUEPRINT 52 HAMMER 53 PAINT_ROLLER 54 PAINT_BRUSH 55 BOOK_OPEN_TEXT 56 PEN_NIB 57 PALETTE 58 CLIPBOARD 59 PIANO_KEYS 60 SPEAKER_HIFI 61 BOOK 62 PAPERCLIP 63 PAINT_BUCKET 64 GUITAR 65 MICROPHONE_STAGE 66 GAME_CONTROLLER 67 PENCIL 68 APERTURE 69 BATTERY_FULL coverPhotoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
pricesobjectA map of
PriceTierids to prices.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The updated Consumable.
consumableobject