Scheduler cases

>>>

GET /api/v4/scheduler_cases
List Scheduler Cases

Scheduler Cases associated with your company

Examples

{
  "total_records": integer,
  "page_number": integer,
  "data": [
    {
      "id": integer,
      "is_video_streamed": boolean,
      "is_text_streamed": boolean,
      "created_at": datetime,
      "updated_at": datetime,
      "is_teleconferenced": boolean,
      "is_cameo": boolean,
      "case": {
        "name": string
      }
    },
    ...
  ]
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
page_number
optional

Page Number

Validations:

  • Must be a Integer
>>>

GET /api/v4/scheduler_cases/:id
Find Scheduler Case

Returns all attributes of a Scheduler Case

Errors

Code Description
404 Not Found

Examples

{
  "id": integer,
  "is_video_streamed": boolean,
  "is_text_streamed": boolean,
  "created_at": datetime,
  "updated_at": datetime,
  "is_teleconferenced": boolean,
  "is_cameo": boolean,
  "case": {
    "name": string
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of Scheduler Case

Validations:

  • Must be a Integer
>>>

POST /api/v4/scheduler_cases
Create Scheduler Case

Create a Scheduler Case

Errors

Code Description
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "is_video_streamed": boolean,
  "is_text_streamed": boolean,
  "created_at": datetime,
  "updated_at": datetime,
  "is_teleconferenced": boolean,
  "is_cameo": boolean,
  "case": {
    "name": string
  }

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
name
required

Case Name

Validations:

  • Must be a String
is_cameo
optional

Enable cameo

Validations:

  • Must be one of: true, false.
is_video_streamed
optional

Enable video

Validations:

  • Must be one of: true, false.
is_text_streamed
optional

Enable text

Validations:

  • Must be one of: true, false.
is_teleconferenced
optional

Enable audio conferencing

Validations:

  • Must be one of: true, false.
>>>

PATCH /api/v4/scheduler_cases/:id
Update Scheduler Case

Update a Scheduler Case

Errors

Code Description
404 Not Found
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "is_video_streamed": boolean,
  "is_text_streamed": boolean,
  "created_at": datetime,
  "updated_at": datetime,
  "is_teleconferenced": boolean,
  "is_cameo": boolean,
  "case": {
    "name": string
  }

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of Scheduler Case

Validations:

  • Must be a Integer
name
required

Case Name

Validations:

  • Must be a String
is_cameo
optional

Enable cameo

Validations:

  • Must be one of: true, false.
is_video_streamed
optional

Enable video

Validations:

  • Must be one of: true, false.
is_text_streamed
optional

Enable text

Validations:

  • Must be one of: true, false.
is_teleconferenced
optional

Enable audio conferencing

Validations:

  • Must be one of: true, false.