Select Slots ALPHA

Description #

Enables the recording of an individual participant’s choice of slots.

POST {slots_select_url} HTTP/1.1
Host: {data_center_url}
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json; charset=utf-8

{
  "selected_slots" : [
    {
      "slot_id": "slt_1529540802"
    }
  ]
}

Request parameters #

choose_slot_url_path required  #

The participant.slots_select.url for the participant.

selected_slots required  #

An array of slots the participant has chosen.

Currently the maxium number of selected_slots is one.

selected_slots.slot_id  #

The value of the slot_id parameter for the slot from the participant.slots_list.url result.

Example Response #

The latest representation of the scheduling conversation.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "participants": [
    {
      "participant_id": "@grace",
      "sub": "acc_5ba21743f408617d1269ea1e",
      "email": "grace@company.com",
      "common_name": "Grace Devlin",
      "slots": {
        "selection_method": "auto",
        "selected": [
          {
            "slot_id": "slt_1529540802",
            "start": "2024-07-28T00:09:00Z",
            "end": "2024-07-28T00:10:00Z"
          }
        ]
      },
      "status": "complete",
      "possible_actions": {}
    },
    {
      "participant_id": "@karl",
      "common_name": "Karl Cramer",
      "slots": {
        "selection_method": "manual",
        "selected": [
          {
            "slot_id": "slt_1529540802",
            "start": "2024-07-28T00:09:00Z",
            "end": "2024-07-28T00:10:00Z"
          }
        ]
      }
      "status": "complete",
      "possible_actions": {}
    }
  ],
  "tzid": "America/Chicago",
  "required_duration": {
    "minutes": 60
  },
  "available_periods": [
    {
      "start": "2024-07-28T09:00:00Z",
      "end": "2024-07-28T18:00:00Z"
    },
  ],
  "chosen_slot": {
    "available_slot_id": "slt_1529540802",
    "start": "2024-07-28T00:09:00Z",
    "end": "2024-07-28T00:10:00Z"
  },
  "status": "complete"
}