Guides

Meeting services

Services are things people can request with a meeting, such as catering or equipment hire.

Creating a service

Send a POST request to /services.

The required fields are:

  • name: up to 60 characters
  • provider: the email address orders are sent to, up to 60 characters
  • availability
  • chargable, plus currency_id when chargable is true

These must also be sent, but can be empty: description (up to 255 characters, or null), and roles, teams, users, rooms and items (arrays). Send [] for no restriction or no items.

{
  "name": "Lunch platter",
  "description": "Sandwiches and fruit, delivered to the room",
  "provider": "kitchen@example.com",
  "chargable": true,
  "currency_id": "c90d8b0b-f5ee-4e50-9912-e5850b1771b6",
  "availability": [
    { "weekday": 1, "from": "08:00", "to": "12:00" },
    { "weekday": 2, "from": "08:00", "to": "12:00" },
    { "weekday": 3, "from": "08:00", "to": "12:00" },
    { "weekday": 4, "from": "08:00", "to": "12:00" },
    { "weekday": 5, "from": "00:00", "to": "00:00" },
    { "weekday": 6, "from": "00:00", "to": "00:00" },
    { "weekday": 7, "from": "00:00", "to": "00:00" }
  ],
  "roles": [],
  "teams": [],
  "users": [],
  "rooms": [],
  "items": []
}

Availability

Send one item per day of the week:

Field Notes
weekday 1 is Monday, 7 is Sunday
from Time the service becomes available, HH:MM
to Time the service stops being available, HH:MM

If the service isn't available on a day, send both from and to as "00:00".

Restricting who can order it

A service can be limited to certain users, roles, teams and rooms, each an array of IDs. An empty array means no restriction. For example, to let only people with the admin role order a service:

{
  "roles": ["c7f96563-24b7-4ccf-ae26-263c20de43e2"]
}

Cut-off time

If a service must be ordered a certain time ahead, send cut_off_limit_duration as an integer and cut_off_limit_period as "hours" or "minutes". Send allow_edit_after_cut_off to say whether an order can still be changed after the cut-off.

With a 3-hour cut-off, someone creating a meeting that starts within the next 3 hours can't add the service.

{
  "cut_off_limit_duration": 3,
  "cut_off_limit_period": "hours",
  "allow_edit_after_cut_off": false
}

Service items

Send items as an array of the things that can be ordered from the service.

Field Notes
name Required, up to 60 characters
description Must be sent; up to 255 characters, or null
min_quantity, max_quantity Must be sent. Send both as 0 for items that aren't counted
price Must be sent. Price per item
order Optional. Position in the list
{
  "items": [
    {
      "name": "Sandwich platter",
      "description": "Serves 6",
      "min_quantity": 0,
      "max_quantity": 12,
      "price": 10,
      "order": 1
    },
    {
      "name": "Room set-up",
      "description": "Tables arranged before the meeting",
      "min_quantity": 0,
      "max_quantity": 0,
      "price": 20,
      "order": 2
    }
  ]
}