Getting Started

Creating an Account

If your organization is already part of Tellescope, an administrator can send you an invitation to register through their Settings page.

To register a new account and create a new organization:
  • Register for a new account
  • Confirm your email address
  • Create a new organization (making you an administrator)

Once you have an account, you can generate an API key in your Settings page.

Environments (Production vs Sandbox/Staging)

If your login is for business.tellescope.com, this is production, with base API URL https://api.tellescope.com/v1
If your login is for staging.tellescope.com, your API URL is https://staging-api.tellescope.com/v1

Users vs Endusers (Patients)

Users represent your and your team members' Tellescope accounts.
Endusers represent your patient/client records

Authentication

Include an API key (Secret Key) in each request with the apiKey parameter.
You can also include the API key using Authentication header with API_KEY {YOUR_KEY_HERE}
For enduser authentication, you can include an authToken as a Bearer Token in requests.

Public endpoints do not require authentication.

Documentation Conventions

Authentication info is omitted from examples in favor of conciseness.
A question mark (?) in example input indicates an optional parameter.

Updating Records

Records are created, updated, and returned as JSON. Most fields are represented as strings or numbers, but others are more complicated.
When updating array fields, values are appended by default.
When updating object fields, only the given key-values pairs are overwritten by default.
To overwrite an array or object in an update, use { replaceObjectFields: true } in the "options" parameter
To prevent webhook echo when updating records using an API key, use { dontSendWebhook: true } in the "options" parameter

Common fields

All records share the following fields

  • id: a unique identifier for the record
  • createdAt: a timestamp representing when the document was created
  • updatedAt: a timestamp representing when the document was most recently updated
  • businessId: a unique identifier for your organization

Other shared fields include organizationIds and sharedWithOrganizations
These should be omitted from your API requests, unless you are working with an account that leverages sub-organizations (deprecated)

Pagination

When reading multiple records, e.g. GET Endusers, no more than 100 results will be returned by default.
To fetch the next page of records, you can pass the id of the last record returned as the lastId parameter.
Here's an example using the TypeScript SDK for loading all of the Endusers in pages of size 250:

1const load_all_endusers = async (limit=250) => {
2  const endusers: Enduser[] = []
3
4  while (true) {
5    const loaded = await sdk.api.endusers.getSome({ 
6      limit, 
7      lastId: endusers[endusers.length - 1]?.id,
8    })
9
10    endusers.push(...loaded)
11
12    if (loaded.length < limit) break; 
13  }
14
15  return endusers
16}

Webhooks

Using our API, you can create a webhook configuration which subscribes to create, update, or delete notifications for each model in Tellescope. View the Webhooks section for more details.

UI Components and Other Details

For documentation of our UI component libraries for React/React Native as well as other guides on integration, you can check our our Notion documentation.

AnalyticsFrames

Constraints

  • Title is required when parentFrame is undefined

Get analytics for query

Method: GET

https://api.tellescope.com/v1/result-for-analytics-query

Returns a computed result for an analytics query

{
  "query": [
    [
      {
        "resource": "string",
        "filter": {
          "activeSince": "Date",
          "gender": "string",
          "fields": [
            {
              "key": "example string",
              "value": "example string",
              "range": {
                "from": "2024-05-29T11:31:12.890Z",
                "to": "2024-05-29T11:31:12.890Z"
              }
            }
          ],
          "Submitted Forms": {
            "qualifier": "string",
            "formIds": [
              "60398b0231a295e64f084fd9"
            ],
            "formResponseCondition": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          "assignedTo": {
            "qualifier": "string",
            "userIds": [
              "60398b0231a295e64f084fd9"
            ]
          },
          "born": {
            "from": "Date",
            "to": "Date"
          },
          "tags": {
            "qualifier": "string",
            "values": [
              "example string"
            ]
          }
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "templateIds": [
            "60398b0231a295e64f084fd9"
          ],
          "starts": {
            "from": "Date",
            "to": "Date"
          },
          "wasSelfScheduled": "boolean",
          "wasCancelled": "boolean",
          "wasNoShowed": "boolean",
          "wasRescheduled": "boolean",
          "userIds": [
            "60398b0231a295e64f084fd9"
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Type": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "formIds": [
            "60398b0231a295e64f084fd9"
          ],
          "formResponseCondition": [
            [
              { },
              { "key": string }
            ]
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Public Identifier": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Cost": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Owner": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            },
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "direction": "string",
          "messages": [
            "example string"
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Score": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "names": [
            "example string"
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      }
    ]
  ],
  "createdRange?": {
    "from": "Date",
    "to": "Date"
  },
  "updatedRange?": {
    "from": "Date",
    "to": "Date"
  },
  "groupByCareTeam?": "boolean"
}

Get custom report

Method: GET

https://api.tellescope.com/v1/analytics/custom-report

For customized analytics reporting, pre-configured by the Tellescope team for a given organization

{
  "key": "string",
  "lastId?": "string",
  "limit?": "number"
}

Create AnalyticsFrame

Method: POST

https://api.tellescope.com/v1/analytics-frame

Creates a new AnalyticsFrame

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "query": [
    [
      {
        "resource": "string",
        "filter": {
          "activeSince": "Date",
          "gender": "string",
          "fields": [
            {
              "key": "example string",
              "value": "example string",
              "range": {
                "from": "2024-05-29T11:31:12.891Z",
                "to": "2024-05-29T11:31:12.891Z"
              }
            }
          ],
          "Submitted Forms": {
            "qualifier": "string",
            "formIds": [
              "60398b0231a295e64f084fd9"
            ],
            "formResponseCondition": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          "assignedTo": {
            "qualifier": "string",
            "userIds": [
              "60398b0231a295e64f084fd9"
            ]
          },
          "born": {
            "from": "Date",
            "to": "Date"
          },
          "tags": {
            "qualifier": "string",
            "values": [
              "example string"
            ]
          }
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "templateIds": [
            "60398b0231a295e64f084fd9"
          ],
          "starts": {
            "from": "Date",
            "to": "Date"
          },
          "wasSelfScheduled": "boolean",
          "wasCancelled": "boolean",
          "wasNoShowed": "boolean",
          "wasRescheduled": "boolean",
          "userIds": [
            "60398b0231a295e64f084fd9"
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Type": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "formIds": [
            "60398b0231a295e64f084fd9"
          ],
          "formResponseCondition": [
            [
              { },
              { "key": string }
            ]
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Public Identifier": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Cost": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Owner": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            },
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "direction": "string",
          "messages": [
            "example string"
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Score": "boolean",
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "names": [
            "example string"
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Enduser": "boolean",
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string",
          "Tags": "boolean",
          "Age": "boolean",
          "State": "boolean"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      }
    ]
  ],
  "createdRange?": {
    "from": "Date",
    "to": "Date"
  },
  "updatedRange?": {
    "from": "Date",
    "to": "Date"
  },
  "parentFrame?": "string",
  "type?": "string",
  "groupMin?": "number",
  "groupMax?": "number",
  "groupByCareTeam?": "boolean"
}

Create AnalyticsFrames

Method: POST

https://api.tellescope.com/v1/analytics-frames

Creates new AnalyticsFrames

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "query": [
        [
          {
            "resource": "string",
            "filter": {
              "activeSince": "Date",
              "gender": "string",
              "fields": [
                {
                  "key": "example string",
                  "value": "example string",
                  "range": {
                    "from": "2024-05-29T11:31:12.891Z",
                    "to": "2024-05-29T11:31:12.891Z"
                  }
                }
              ],
              "Submitted Forms": {
                "qualifier": "string",
                "formIds": [
                  "60398b0231a295e64f084fd9"
                ],
                "formResponseCondition": [
                  [
                    { },
                    { "key": string }
                  ]
                ]
              },
              "assignedTo": {
                "qualifier": "string",
                "userIds": [
                  "60398b0231a295e64f084fd9"
                ]
              },
              "born": {
                "from": "Date",
                "to": "Date"
              },
              "tags": {
                "qualifier": "string",
                "values": [
                  "example string"
                ]
              }
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {
              "templateIds": [
                "60398b0231a295e64f084fd9"
              ],
              "starts": {
                "from": "Date",
                "to": "Date"
              },
              "wasSelfScheduled": "boolean",
              "wasCancelled": "boolean",
              "wasNoShowed": "boolean",
              "wasRescheduled": "boolean",
              "userIds": [
                "60398b0231a295e64f084fd9"
              ]
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Type": "boolean",
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {
              "formIds": [
                "60398b0231a295e64f084fd9"
              ],
              "formResponseCondition": [
                [
                  { },
                  { "key": string }
                ]
              ]
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Public Identifier": "boolean",
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Enduser": "boolean",
              "Cost": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Owner": "boolean",
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                },
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {
              "direction": "string",
              "messages": [
                "example string"
              ]
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Score": "boolean",
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {
              "names": [
                "example string"
              ]
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Enduser": "boolean",
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string",
              "Tags": "boolean",
              "Age": "boolean",
              "State": "boolean"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          }
        ]
      ],
      "createdRange?": {
        "from": "Date",
        "to": "Date"
      },
      "updatedRange?": {
        "from": "Date",
        "to": "Date"
      },
      "parentFrame?": "string",
      "type?": "string",
      "groupMin?": "number",
      "groupMax?": "number",
      "groupByCareTeam?": "boolean"
    }
  ]
}

Update AnalyticsFrame

Method: PATCH

https://api.tellescope.com/v1/analytics-frame/:id

Updates AnalyticsFrame fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "query?": [
      [
        {
          "resource": "string",
          "filter": {
            "activeSince": "Date",
            "gender": "string",
            "fields": [
              {
                "key": "example string",
                "value": "example string",
                "range": {
                  "from": "2024-05-29T11:31:12.891Z",
                  "to": "2024-05-29T11:31:12.891Z"
                }
              }
            ],
            "Submitted Forms": {
              "qualifier": "string",
              "formIds": [
                "60398b0231a295e64f084fd9"
              ],
              "formResponseCondition": [
                [
                  { },
                  { "key": string }
                ]
              ]
            },
            "assignedTo": {
              "qualifier": "string",
              "userIds": [
                "60398b0231a295e64f084fd9"
              ]
            },
            "born": {
              "from": "Date",
              "to": "Date"
            },
            "tags": {
              "qualifier": "string",
              "values": [
                "example string"
              ]
            }
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {
            "templateIds": [
              "60398b0231a295e64f084fd9"
            ],
            "starts": {
              "from": "Date",
              "to": "Date"
            },
            "wasSelfScheduled": "boolean",
            "wasCancelled": "boolean",
            "wasNoShowed": "boolean",
            "wasRescheduled": "boolean",
            "userIds": [
              "60398b0231a295e64f084fd9"
            ]
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Type": "boolean",
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {
            "formIds": [
              "60398b0231a295e64f084fd9"
            ],
            "formResponseCondition": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Public Identifier": "boolean",
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Enduser": "boolean",
            "Cost": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Owner": "boolean",
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              },
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {
            "direction": "string",
            "messages": [
              "example string"
            ]
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Score": "boolean",
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {
            "names": [
              "example string"
            ]
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Enduser": "boolean",
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string",
            "Tags": "boolean",
            "Age": "boolean",
            "State": "boolean"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        }
      ]
    ],
    "createdRange?": {
      "from": "Date",
      "to": "Date"
    },
    "updatedRange?": {
      "from": "Date",
      "to": "Date"
    },
    "parentFrame?": "string",
    "type?": "string",
    "groupMin?": "number",
    "groupMax?": "number",
    "groupByCareTeam?": "boolean"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get AnalyticsFrame

Method: GET

https://api.tellescope.com/v1/analytics-frame/:id

Get an AnalyticsFrame

{
  "filter?": {}
}

Get AnalyticsFrames

Method: GET

https://api.tellescope.com/v1/analytics-frames

Get a page of AnalyticsFrames

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete AnalyticsFrame

Method: DELETE

https://api.tellescope.com/v1/analytics-frame/:id

Delete one AnalyticsFrame

Authentication info only

ApiKeys

Generate ApiKey

Method: POST

https://api.tellescope.com/v1/api-key

Generates and returns a new ApiKey. The returned key is not stored in Tellescope and cannot be retrieved later.

Authentication info only

Get ApiKey

Method: GET

https://api.tellescope.com/v1/api-key/:id

Get an ApiKey

{
  "filter?": {}
}

Get ApiKeys

Method: GET

https://api.tellescope.com/v1/api-keys

Get a page of ApiKeys

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete ApiKey

Method: DELETE

https://api.tellescope.com/v1/api-key/:id

Delete one ApiKey

Authentication info only

AppointmentBookingPages

Constraints

  • title must be unique across AppointmentBookingPages

Validate Access Token (Public)

Method: GET

https://api.tellescope.com/v1/appointment-booking-pages/validate-access-token

Validates an appointment booking token

{
  "token": "string",
  "bookingPageId?": "string"
}

Generate Access Token

Method: POST

https://api.tellescope.com/v1/appointment-booking-pages/generate-access-token

Generates a 1-time access token for booking an appointment

{
  "expiresAt": "Date",
  "bookingPageId?": "string"
}

Create AppointmentBookingPage

Method: POST

https://api.tellescope.com/v1/appointment-booking-page

Creates a new AppointmentBookingPage

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "calendarEventTemplateIds": [
    "60398b0231a295e64f084fd9"
  ],
  "locationIds": [
    "60398b0231a295e64f084fd9"
  ],
  "terms?": [
    {
      "link": "example string",
      "title": "example string"
    }
  ],
  "endDate?": "Date",
  "startDate?": "Date",
  "intakeTitle?": "string",
  "intakeDescription?": "string",
  "thankYouRedirectURL?": "string",
  "thankYouTitle?": "string",
  "thankYouDescription?": "string",
  "thankYouHeaderImageURL?": "string",
  "thankYouMainImageURL?": "string",
  "hiddenFromPortal?": "boolean",
  "hoursBeforeBookingAllowed?": "number",
  "limitedToCareTeam?": "boolean",
  "limitedByState?": "boolean",
  "topLogo?": "string",
  "requireLocationSelection?": "boolean"
}

Create AppointmentBookingPages

Method: POST

https://api.tellescope.com/v1/appointment-booking-pages

Creates new AppointmentBookingPages

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "calendarEventTemplateIds": [
        "60398b0231a295e64f084fd9"
      ],
      "locationIds": [
        "60398b0231a295e64f084fd9"
      ],
      "terms?": [
        {
          "link": "example string",
          "title": "example string"
        }
      ],
      "endDate?": "Date",
      "startDate?": "Date",
      "intakeTitle?": "string",
      "intakeDescription?": "string",
      "thankYouRedirectURL?": "string",
      "thankYouTitle?": "string",
      "thankYouDescription?": "string",
      "thankYouHeaderImageURL?": "string",
      "thankYouMainImageURL?": "string",
      "hiddenFromPortal?": "boolean",
      "hoursBeforeBookingAllowed?": "number",
      "limitedToCareTeam?": "boolean",
      "limitedByState?": "boolean",
      "topLogo?": "string",
      "requireLocationSelection?": "boolean"
    }
  ]
}

Update AppointmentBookingPage

Method: PATCH

https://api.tellescope.com/v1/appointment-booking-page/:id

Updates AppointmentBookingPage fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "calendarEventTemplateIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "locationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "terms?": [
      {
        "link": "example string",
        "title": "example string"
      }
    ],
    "endDate?": "Date",
    "startDate?": "Date",
    "intakeTitle?": "string",
    "intakeDescription?": "string",
    "thankYouRedirectURL?": "string",
    "thankYouTitle?": "string",
    "thankYouDescription?": "string",
    "thankYouHeaderImageURL?": "string",
    "thankYouMainImageURL?": "string",
    "hiddenFromPortal?": "boolean",
    "hoursBeforeBookingAllowed?": "number",
    "limitedToCareTeam?": "boolean",
    "limitedByState?": "boolean",
    "topLogo?": "string",
    "requireLocationSelection?": "boolean"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get AppointmentBookingPage

Method: GET

https://api.tellescope.com/v1/appointment-booking-page/:id

Get an AppointmentBookingPage

{
  "filter?": {}
}

Get AppointmentBookingPages

Method: GET

https://api.tellescope.com/v1/appointment-booking-pages

Get a page of AppointmentBookingPages

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete AppointmentBookingPage

Method: DELETE

https://api.tellescope.com/v1/appointment-booking-page/:id

Delete one AppointmentBookingPage

Authentication info only

AppointmentLocations

Constraints

  • title must be unique across AppointmentLocations

Create AppointmentLocation

Method: POST

https://api.tellescope.com/v1/appointment-location

Creates a new AppointmentLocation

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "address?": "string",
  "zipCode?": "string",
  "phone?": "string",
  "state?": "string",
  "timezone?": "string",
  "canvasLocationId?": "string"
}

Create AppointmentLocations

Method: POST

https://api.tellescope.com/v1/appointment-locations

Creates new AppointmentLocations

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "address?": "string",
      "zipCode?": "string",
      "phone?": "string",
      "state?": "string",
      "timezone?": "string",
      "canvasLocationId?": "string"
    }
  ]
}

Update AppointmentLocation

Method: PATCH

https://api.tellescope.com/v1/appointment-location/:id

Updates AppointmentLocation fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "address?": "string",
    "zipCode?": "string",
    "phone?": "string",
    "state?": "string",
    "timezone?": "string",
    "canvasLocationId?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get AppointmentLocation

Method: GET

https://api.tellescope.com/v1/appointment-location/:id

Get an AppointmentLocation

{
  "filter?": {}
}

Get AppointmentLocations

Method: GET

https://api.tellescope.com/v1/appointment-locations

Get a page of AppointmentLocations

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete AppointmentLocation

Method: DELETE

https://api.tellescope.com/v1/appointment-location/:id

Delete one AppointmentLocation

Authentication info only

AutomatedActions

Create AutomatedAction

Method: POST

https://api.tellescope.com/v1/automated-action

Creates a new AutomatedAction

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "cancelConditions?": [
    {
      "type": "string",
      "info": {
        "automationStepId": "string"
      }
    }
  ],
  "automationStepId": "string",
  "enduserId": "string",
  "journeyId": "string",
  "event": [
    [
      {
        "type": "string",
        "info": {
          "automationStepId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "automationStepId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "automationStepId": "string",
          "delayInMS": "number",
          "delay": "number",
          "unit": "string",
          "cancelConditions": [
            {
              "type": "formResponse",
              "info": {
                "automationStepId": "60398b0231a295e64f084fd9"
              }
            }
          ],
          "officeHoursOnly": "boolean",
          "formCondition": {
            "formId": "string",
            "formFieldId": "string",
            "before": "boolean"
          },
          "fieldCondition": {
            "field": "string",
            "before": "boolean"
          }
        }
      },
      {
        "type": "string",
        "info": {
          "automationStepId": "string",
          "delayInMS": "number",
          "delay": "number",
          "unit": "string",
          "cancelConditions": [
            {
              "type": "formResponse",
              "info": {
                "automationStepId": "60398b0231a295e64f084fd9"
              }
            }
          ],
          "officeHoursOnly": "boolean"
        }
      },
      {
        "type": "string",
        "info": {
          "automationStepId": "string",
          "delayInMS": "number",
          "delay": "number",
          "unit": "string",
          "cancelConditions": [
            {
              "type": "formResponse",
              "info": {
                "automationStepId": "60398b0231a295e64f084fd9"
              }
            }
          ],
          "officeHoursOnly": "boolean"
        }
      },
      {
        "type": "string",
        "info": {}
      },
      {
        "type": "string",
        "info": {
          "automationStepId": "string",
          "closedForReason": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "automationStepId": "string",
          "triggerId": "string"
        }
      }
    ]
  ],
  "action": [
    [
      {
        "type": "string",
        "info": {
          "status": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "templateId": "string",
          "assignment": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "templateId": "string",
          "assignment": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "templateId": "string",
          "forAssigned": "boolean",
          "roles": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "formId": "string",
          "channel": "string",
          "assignment": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "managedContentRecordIds": [
            "60398b0231a295e64f084fd9"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "description": "string",
          "assignmentStrategy": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {
                  "qualifier": "string",
                  "values": [
                    "example string"
                  ]
                }
              },
              {
                "type": "string",
                "info": {
                  "queueId": "string"
                }
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ],
          "closeReasons": [
            "example string"
          ],
          "restrictByState": "boolean",
          "restrictByCareTeam": "boolean",
          "defaultAssignee": "string",
          "forCarePlan": "boolean",
          "hiddenFromTickets": "boolean",
          "htmlDescription": "string",
          "actions": [
            {
              "type": "Complete Form",
              "info": {
                "formId": "60398b0231a295e64f084fd9",
                "formResponseId": "60398b0231a295e64f084fd9"
              },
              "completedAt": "2024-05-29T11:31:12.879Z",
              "optional": true
            }
          ],
          "dueDateOffsetInMS": "number",
          "closeOnFinishedActions": "boolean",
          "requireConfirmation": "boolean",
          "reminders": [
            {
              "msBeforeDueDate": -10000000000000,
              "didRemind": true
            }
          ],
          "priority": "number",
          "preserveContext": "boolean"
        }
      },
      {
        "type": "string",
        "info": {
          "message": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "fields": [
            {
              "name": "example string",
              "type": "example string",
              "value": "example string"
            }
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "journeyId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "journeyId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "campaignId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "eventName": "string",
          "description": "string",
          "dataFieldsMapping": [
            {
              "iterable": "example string",
              "tellescope": "example string"
            }
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "templateId": "string",
          "defaultSenderId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "htmlDescription": "string",
          "hideRemainingTicketsProgress": "boolean",
          "highlightedEnduserFields": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {}
      },
      {
        "type": "string",
        "info": {}
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "type": "string",
          "serviceId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "lines": [
            {
              "quantity": 0,
              "sku": "example string"
            }
          ]
        }
      },
      {
        "type": "string",
        "info": {}
      },
      {
        "type": "string",
        "info": {
          "journeyIds": [
            "60398b0231a295e64f084fd9"
          ]
        }
      }
    ]
  ],
  "status": "string",
  "processAfter": "number"
}

Create AutomatedActions

Method: POST

https://api.tellescope.com/v1/automated-actions

Creates new AutomatedActions

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "cancelConditions?": [
        {
          "type": "string",
          "info": {
            "automationStepId": "string"
          }
        }
      ],
      "automationStepId": "string",
      "enduserId": "string",
      "journeyId": "string",
      "event": [
        [
          {
            "type": "string",
            "info": {
              "automationStepId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "automationStepId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "automationStepId": "string",
              "delayInMS": "number",
              "delay": "number",
              "unit": "string",
              "cancelConditions": [
                {
                  "type": "formResponse",
                  "info": {
                    "automationStepId": "60398b0231a295e64f084fd9"
                  }
                }
              ],
              "officeHoursOnly": "boolean",
              "formCondition": {
                "formId": "string",
                "formFieldId": "string",
                "before": "boolean"
              },
              "fieldCondition": {
                "field": "string",
                "before": "boolean"
              }
            }
          },
          {
            "type": "string",
            "info": {
              "automationStepId": "string",
              "delayInMS": "number",
              "delay": "number",
              "unit": "string",
              "cancelConditions": [
                {
                  "type": "formResponse",
                  "info": {
                    "automationStepId": "60398b0231a295e64f084fd9"
                  }
                }
              ],
              "officeHoursOnly": "boolean"
            }
          },
          {
            "type": "string",
            "info": {
              "automationStepId": "string",
              "delayInMS": "number",
              "delay": "number",
              "unit": "string",
              "cancelConditions": [
                {
                  "type": "formResponse",
                  "info": {
                    "automationStepId": "60398b0231a295e64f084fd9"
                  }
                }
              ],
              "officeHoursOnly": "boolean"
            }
          },
          {
            "type": "string",
            "info": {}
          },
          {
            "type": "string",
            "info": {
              "automationStepId": "string",
              "closedForReason": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "automationStepId": "string",
              "triggerId": "string"
            }
          }
        ]
      ],
      "action": [
        [
          {
            "type": "string",
            "info": {
              "status": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "templateId": "string",
              "assignment": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "templateId": "string",
              "assignment": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "templateId": "string",
              "forAssigned": "boolean",
              "roles": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "formId": "string",
              "channel": "string",
              "assignment": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "managedContentRecordIds": [
                "60398b0231a295e64f084fd9"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "description": "string",
              "assignmentStrategy": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {
                      "qualifier": "string",
                      "values": [
                        "example string"
                      ]
                    }
                  },
                  {
                    "type": "string",
                    "info": {
                      "queueId": "string"
                    }
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ],
              "closeReasons": [
                "example string"
              ],
              "restrictByState": "boolean",
              "restrictByCareTeam": "boolean",
              "defaultAssignee": "string",
              "forCarePlan": "boolean",
              "hiddenFromTickets": "boolean",
              "htmlDescription": "string",
              "actions": [
                {
                  "type": "Complete Form",
                  "info": {
                    "formId": "60398b0231a295e64f084fd9",
                    "formResponseId": "60398b0231a295e64f084fd9"
                  },
                  "completedAt": "2024-05-29T11:31:12.879Z",
                  "optional": true
                }
              ],
              "dueDateOffsetInMS": "number",
              "closeOnFinishedActions": "boolean",
              "requireConfirmation": "boolean",
              "reminders": [
                {
                  "msBeforeDueDate": -10000000000000,
                  "didRemind": true
                }
              ],
              "priority": "number",
              "preserveContext": "boolean"
            }
          },
          {
            "type": "string",
            "info": {
              "message": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "fields": [
                {
                  "name": "example string",
                  "type": "example string",
                  "value": "example string"
                }
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "journeyId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "journeyId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "campaignId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "eventName": "string",
              "description": "string",
              "dataFieldsMapping": [
                {
                  "iterable": "example string",
                  "tellescope": "example string"
                }
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "templateId": "string",
              "defaultSenderId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "htmlDescription": "string",
              "hideRemainingTicketsProgress": "boolean",
              "highlightedEnduserFields": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {}
          },
          {
            "type": "string",
            "info": {}
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "type": "string",
              "serviceId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "lines": [
                {
                  "quantity": 0,
                  "sku": "example string"
                }
              ]
            }
          },
          {
            "type": "string",
            "info": {}
          },
          {
            "type": "string",
            "info": {
              "journeyIds": [
                "60398b0231a295e64f084fd9"
              ]
            }
          }
        ]
      ],
      "status": "string",
      "processAfter": "number"
    }
  ]
}

Update AutomatedAction

Method: PATCH

https://api.tellescope.com/v1/automated-action/:id

Updates AutomatedAction fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "cancelConditions?": [
      {
        "type": "string",
        "info": {
          "automationStepId": "string"
        }
      }
    ],
    "automationStepId?": "string",
    "enduserId?": "string",
    "journeyId?": "string",
    "event?": [
      [
        {
          "type": "string",
          "info": {
            "automationStepId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "automationStepId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "automationStepId": "string",
            "delayInMS": "number",
            "delay": "number",
            "unit": "string",
            "cancelConditions": [
              {
                "type": "formResponse",
                "info": {
                  "automationStepId": "60398b0231a295e64f084fd9"
                }
              }
            ],
            "officeHoursOnly": "boolean",
            "formCondition": {
              "formId": "string",
              "formFieldId": "string",
              "before": "boolean"
            },
            "fieldCondition": {
              "field": "string",
              "before": "boolean"
            }
          }
        },
        {
          "type": "string",
          "info": {
            "automationStepId": "string",
            "delayInMS": "number",
            "delay": "number",
            "unit": "string",
            "cancelConditions": [
              {
                "type": "formResponse",
                "info": {
                  "automationStepId": "60398b0231a295e64f084fd9"
                }
              }
            ],
            "officeHoursOnly": "boolean"
          }
        },
        {
          "type": "string",
          "info": {
            "automationStepId": "string",
            "delayInMS": "number",
            "delay": "number",
            "unit": "string",
            "cancelConditions": [
              {
                "type": "formResponse",
                "info": {
                  "automationStepId": "60398b0231a295e64f084fd9"
                }
              }
            ],
            "officeHoursOnly": "boolean"
          }
        },
        {
          "type": "string",
          "info": {}
        },
        {
          "type": "string",
          "info": {
            "automationStepId": "string",
            "closedForReason": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "automationStepId": "string",
            "triggerId": "string"
          }
        }
      ]
    ],
    "action?": [
      [
        {
          "type": "string",
          "info": {
            "status": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "templateId": "string",
            "assignment": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "templateId": "string",
            "assignment": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "templateId": "string",
            "forAssigned": "boolean",
            "roles": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "formId": "string",
            "channel": "string",
            "assignment": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "managedContentRecordIds": [
              "60398b0231a295e64f084fd9"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "description": "string",
            "assignmentStrategy": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {
                    "qualifier": "string",
                    "values": [
                      "example string"
                    ]
                  }
                },
                {
                  "type": "string",
                  "info": {
                    "queueId": "string"
                  }
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ],
            "closeReasons": [
              "example string"
            ],
            "restrictByState": "boolean",
            "restrictByCareTeam": "boolean",
            "defaultAssignee": "string",
            "forCarePlan": "boolean",
            "hiddenFromTickets": "boolean",
            "htmlDescription": "string",
            "actions": [
              {
                "type": "Complete Form",
                "info": {
                  "formId": "60398b0231a295e64f084fd9",
                  "formResponseId": "60398b0231a295e64f084fd9"
                },
                "completedAt": "2024-05-29T11:31:12.879Z",
                "optional": true
              }
            ],
            "dueDateOffsetInMS": "number",
            "closeOnFinishedActions": "boolean",
            "requireConfirmation": "boolean",
            "reminders": [
              {
                "msBeforeDueDate": -10000000000000,
                "didRemind": true
              }
            ],
            "priority": "number",
            "preserveContext": "boolean"
          }
        },
        {
          "type": "string",
          "info": {
            "message": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "fields": [
              {
                "name": "example string",
                "type": "example string",
                "value": "example string"
              }
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "journeyId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "journeyId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "campaignId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "eventName": "string",
            "description": "string",
            "dataFieldsMapping": [
              {
                "iterable": "example string",
                "tellescope": "example string"
              }
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "templateId": "string",
            "defaultSenderId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "htmlDescription": "string",
            "hideRemainingTicketsProgress": "boolean",
            "highlightedEnduserFields": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {}
        },
        {
          "type": "string",
          "info": {}
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "type": "string",
            "serviceId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "lines": [
              {
                "quantity": 0,
                "sku": "example string"
              }
            ]
          }
        },
        {
          "type": "string",
          "info": {}
        },
        {
          "type": "string",
          "info": {
            "journeyIds": [
              "60398b0231a295e64f084fd9"
            ]
          }
        }
      ]
    ],
    "status?": "string",
    "processAfter?": "number"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get AutomatedAction

Method: GET

https://api.tellescope.com/v1/automated-action/:id

Get an AutomatedAction

{
  "filter?": {}
}

Get AutomatedActions

Method: GET

https://api.tellescope.com/v1/automated-actions

Get a page of AutomatedActions

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete AutomatedAction

Method: DELETE

https://api.tellescope.com/v1/automated-action/:id

Delete one AutomatedAction

Authentication info only

AutomationSteps

Constraints

  • Event, action, and conditions cannot all be shared by an existing event automation (no duplicates)

Create AutomationStep

Method: POST

https://api.tellescope.com/v1/automation-step

Creates a new AutomationStep

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "journeyId": "string",
  "events": [
    {
      "type": "formResponse",
      "info": {
        "automationStepId": "60398b0231a295e64f084fd9"
      }
    }
  ],
  "action": [
    [
      {
        "type": "string",
        "info": {
          "status": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "templateId": "string",
          "assignment": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "templateId": "string",
          "assignment": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "templateId": "string",
          "forAssigned": "boolean",
          "roles": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "formId": "string",
          "channel": "string",
          "assignment": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "managedContentRecordIds": [
            "60398b0231a295e64f084fd9"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "description": "string",
          "assignmentStrategy": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {
                  "qualifier": "string",
                  "values": [
                    "example string"
                  ]
                }
              },
              {
                "type": "string",
                "info": {
                  "queueId": "string"
                }
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ],
          "closeReasons": [
            "example string"
          ],
          "restrictByState": "boolean",
          "restrictByCareTeam": "boolean",
          "defaultAssignee": "string",
          "forCarePlan": "boolean",
          "hiddenFromTickets": "boolean",
          "htmlDescription": "string",
          "actions": [
            {
              "type": "Complete Form",
              "info": {
                "formId": "60398b0231a295e64f084fd9",
                "formResponseId": "60398b0231a295e64f084fd9"
              },
              "completedAt": "2024-05-29T11:31:12.878Z",
              "optional": true
            }
          ],
          "dueDateOffsetInMS": "number",
          "closeOnFinishedActions": "boolean",
          "requireConfirmation": "boolean",
          "reminders": [
            {
              "msBeforeDueDate": -10000000000000,
              "didRemind": true
            }
          ],
          "priority": "number",
          "preserveContext": "boolean"
        }
      },
      {
        "type": "string",
        "info": {
          "message": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "fields": [
            {
              "name": "example string",
              "type": "example string",
              "value": "example string"
            }
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "journeyId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "journeyId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "campaignId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "eventName": "string",
          "description": "string",
          "dataFieldsMapping": [
            {
              "iterable": "example string",
              "tellescope": "example string"
            }
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "templateId": "string",
          "defaultSenderId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "htmlDescription": "string",
          "hideRemainingTicketsProgress": "boolean",
          "highlightedEnduserFields": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {}
      },
      {
        "type": "string",
        "info": {}
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "type": "string",
          "serviceId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "lines": [
            {
              "quantity": 0,
              "sku": "example string"
            }
          ]
        }
      },
      {
        "type": "string",
        "info": {}
      },
      {
        "type": "string",
        "info": {
          "journeyIds": [
            "60398b0231a295e64f084fd9"
          ]
        }
      }
    ]
  ],
  "conditions?": [
    {
      "type": "atJourneyState",
      "info": {
        "journeyId": "60398b0231a295e64f084fd9"
      }
    }
  ],
  "flowchartUI?": {
    "x": "number",
    "y": "number"
  },
  "continueOnError?": "boolean",
  "enduserConditions?": { },
  "tags?": [
    "example string"
  ]
}

Create AutomationSteps

Method: POST

https://api.tellescope.com/v1/automation-steps

Creates new AutomationSteps

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "journeyId": "string",
      "events": [
        {
          "type": "formResponse",
          "info": {
            "automationStepId": "60398b0231a295e64f084fd9"
          }
        }
      ],
      "action": [
        [
          {
            "type": "string",
            "info": {
              "status": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "templateId": "string",
              "assignment": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "templateId": "string",
              "assignment": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "templateId": "string",
              "forAssigned": "boolean",
              "roles": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "formId": "string",
              "channel": "string",
              "assignment": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "managedContentRecordIds": [
                "60398b0231a295e64f084fd9"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "description": "string",
              "assignmentStrategy": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {
                      "qualifier": "string",
                      "values": [
                        "example string"
                      ]
                    }
                  },
                  {
                    "type": "string",
                    "info": {
                      "queueId": "string"
                    }
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ],
              "closeReasons": [
                "example string"
              ],
              "restrictByState": "boolean",
              "restrictByCareTeam": "boolean",
              "defaultAssignee": "string",
              "forCarePlan": "boolean",
              "hiddenFromTickets": "boolean",
              "htmlDescription": "string",
              "actions": [
                {
                  "type": "Complete Form",
                  "info": {
                    "formId": "60398b0231a295e64f084fd9",
                    "formResponseId": "60398b0231a295e64f084fd9"
                  },
                  "completedAt": "2024-05-29T11:31:12.878Z",
                  "optional": true
                }
              ],
              "dueDateOffsetInMS": "number",
              "closeOnFinishedActions": "boolean",
              "requireConfirmation": "boolean",
              "reminders": [
                {
                  "msBeforeDueDate": -10000000000000,
                  "didRemind": true
                }
              ],
              "priority": "number",
              "preserveContext": "boolean"
            }
          },
          {
            "type": "string",
            "info": {
              "message": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "fields": [
                {
                  "name": "example string",
                  "type": "example string",
                  "value": "example string"
                }
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "journeyId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "journeyId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "campaignId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "eventName": "string",
              "description": "string",
              "dataFieldsMapping": [
                {
                  "iterable": "example string",
                  "tellescope": "example string"
                }
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "templateId": "string",
              "defaultSenderId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "htmlDescription": "string",
              "hideRemainingTicketsProgress": "boolean",
              "highlightedEnduserFields": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {}
          },
          {
            "type": "string",
            "info": {}
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "type": "string",
              "serviceId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "lines": [
                {
                  "quantity": 0,
                  "sku": "example string"
                }
              ]
            }
          },
          {
            "type": "string",
            "info": {}
          },
          {
            "type": "string",
            "info": {
              "journeyIds": [
                "60398b0231a295e64f084fd9"
              ]
            }
          }
        ]
      ],
      "conditions?": [
        {
          "type": "atJourneyState",
          "info": {
            "journeyId": "60398b0231a295e64f084fd9"
          }
        }
      ],
      "flowchartUI?": {
        "x": "number",
        "y": "number"
      },
      "continueOnError?": "boolean",
      "enduserConditions?": { },
      "tags?": [
        "example string"
      ]
    }
  ]
}

Update AutomationStep

Method: PATCH

https://api.tellescope.com/v1/automation-step/:id

Updates AutomationStep fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "journeyId?": "string",
    "events?": [
      {
        "type": "formResponse",
        "info": {
          "automationStepId": "60398b0231a295e64f084fd9"
        }
      }
    ],
    "action?": [
      [
        {
          "type": "string",
          "info": {
            "status": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "templateId": "string",
            "assignment": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "templateId": "string",
            "assignment": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "templateId": "string",
            "forAssigned": "boolean",
            "roles": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "formId": "string",
            "channel": "string",
            "assignment": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "managedContentRecordIds": [
              "60398b0231a295e64f084fd9"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "description": "string",
            "assignmentStrategy": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {
                    "qualifier": "string",
                    "values": [
                      "example string"
                    ]
                  }
                },
                {
                  "type": "string",
                  "info": {
                    "queueId": "string"
                  }
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ],
            "closeReasons": [
              "example string"
            ],
            "restrictByState": "boolean",
            "restrictByCareTeam": "boolean",
            "defaultAssignee": "string",
            "forCarePlan": "boolean",
            "hiddenFromTickets": "boolean",
            "htmlDescription": "string",
            "actions": [
              {
                "type": "Complete Form",
                "info": {
                  "formId": "60398b0231a295e64f084fd9",
                  "formResponseId": "60398b0231a295e64f084fd9"
                },
                "completedAt": "2024-05-29T11:31:12.878Z",
                "optional": true
              }
            ],
            "dueDateOffsetInMS": "number",
            "closeOnFinishedActions": "boolean",
            "requireConfirmation": "boolean",
            "reminders": [
              {
                "msBeforeDueDate": -10000000000000,
                "didRemind": true
              }
            ],
            "priority": "number",
            "preserveContext": "boolean"
          }
        },
        {
          "type": "string",
          "info": {
            "message": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "fields": [
              {
                "name": "example string",
                "type": "example string",
                "value": "example string"
              }
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "journeyId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "journeyId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "campaignId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "eventName": "string",
            "description": "string",
            "dataFieldsMapping": [
              {
                "iterable": "example string",
                "tellescope": "example string"
              }
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "templateId": "string",
            "defaultSenderId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "htmlDescription": "string",
            "hideRemainingTicketsProgress": "boolean",
            "highlightedEnduserFields": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {}
        },
        {
          "type": "string",
          "info": {}
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "type": "string",
            "serviceId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "lines": [
              {
                "quantity": 0,
                "sku": "example string"
              }
            ]
          }
        },
        {
          "type": "string",
          "info": {}
        },
        {
          "type": "string",
          "info": {
            "journeyIds": [
              "60398b0231a295e64f084fd9"
            ]
          }
        }
      ]
    ],
    "conditions?": [
      {
        "type": "atJourneyState",
        "info": {
          "journeyId": "60398b0231a295e64f084fd9"
        }
      }
    ],
    "flowchartUI?": {
      "x": "number",
      "y": "number"
    },
    "continueOnError?": "boolean",
    "enduserConditions?": { },
    "tags?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get AutomationStep

Method: GET

https://api.tellescope.com/v1/automation-step/:id

Get an AutomationStep

{
  "filter?": {}
}

Get AutomationSteps

Method: GET

https://api.tellescope.com/v1/automation-steps

Get a page of AutomationSteps

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete AutomationStep

Method: DELETE

https://api.tellescope.com/v1/automation-step/:id

Delete one AutomationStep

Authentication info only

AutomationTriggers

Trigger Event (Admin Only)

Method: POST

https://api.tellescope.com/v1/automation-triggers/trigger-events

Triggers a list of events for endusers

{
  "triggers": [
    {
      "automationTriggerId": "60398b0231a295e64f084fd9",
      "enduserId": "60398b0231a295e64f084fd9",
      "journeyContext": { }
    }
  ]
}

Create AutomationTrigger

Method: POST

https://api.tellescope.com/v1/automation-trigger

Creates a new AutomationTrigger

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "event": [
    [
      {
        "type": "string",
        "info": {
          "formId": "string",
          "publicIdentifier": "string",
          "submitterType": "string"
        },
        "conditions": [
          [
            { },
            { "key": string }
          ]
        ]
      },
      {
        "type": "string",
        "info": {
          "formId": "string",
          "intervalInMS": "number"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "field": "string",
          "value": "string"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "intervalInMS": "number",
          "templateIds": [
            "example string"
          ],
          "titles": [
            "example string"
          ]
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": { },
        "conditions": { }
      },
      {
        "type": "string",
        "info": { },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "titles": [
            "example string"
          ]
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "titles": [
            "example string"
          ]
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "minutes": "number"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "intervalInMS": "number"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "minutes": "number",
          "units": [
            "example string"
          ],
          "comparison": [
            [
              {
                "type": "string",
                "value": "number"
              },
              {
                "type": "string",
                "value": "number"
              },
              {
                "type": "string",
                "value": {
                  "lower": "number",
                  "upper": "number"
                }
              }
            ]
          ],
          "periodInMS": "number"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "configurationIds": [
            "60398b0231a295e64f084fd9"
          ],
          "classifications": [
            "example string"
          ]
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "templateIds": [
            "60398b0231a295e64f084fd9"
          ],
          "replyKeywords": [
            "example string"
          ]
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {},
        "conditions": { }
      }
    ]
  ],
  "action": [
    [
      {
        "type": "string",
        "info": {
          "journeyId": "string",
          "doNotRestart": "boolean"
        }
      },
      {
        "type": "string",
        "info": {
          "journeyId": "string"
        }
      },
      {
        "type": "string",
        "info": { }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "tags": {
            "qualifier": "string",
            "values": [
              "example string"
            ]
          }
        }
      },
      {
        "type": "string",
        "info": { }
      },
      {
        "type": "string",
        "info": { }
      }
    ]
  ],
  "status": "string",
  "enduserCondition?": [
    [
      { },
      { "key": string }
    ]
  ],
  "journeyId?": "string",
  "oncePerEnduser?": "boolean",
  "triggerNextAt?": "Date"
}

Create AutomationTriggers

Method: POST

https://api.tellescope.com/v1/automation-triggers

Creates new AutomationTriggers

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "event": [
        [
          {
            "type": "string",
            "info": {
              "formId": "string",
              "publicIdentifier": "string",
              "submitterType": "string"
            },
            "conditions": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          {
            "type": "string",
            "info": {
              "formId": "string",
              "intervalInMS": "number"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "field": "string",
              "value": "string"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "intervalInMS": "number",
              "templateIds": [
                "example string"
              ],
              "titles": [
                "example string"
              ]
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": { },
            "conditions": { }
          },
          {
            "type": "string",
            "info": { },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "titles": [
                "example string"
              ]
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "titles": [
                "example string"
              ]
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "minutes": "number"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "intervalInMS": "number"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "minutes": "number",
              "units": [
                "example string"
              ],
              "comparison": [
                [
                  {
                    "type": "string",
                    "value": "number"
                  },
                  {
                    "type": "string",
                    "value": "number"
                  },
                  {
                    "type": "string",
                    "value": {
                      "lower": "number",
                      "upper": "number"
                    }
                  }
                ]
              ],
              "periodInMS": "number"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "configurationIds": [
                "60398b0231a295e64f084fd9"
              ],
              "classifications": [
                "example string"
              ]
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "templateIds": [
                "60398b0231a295e64f084fd9"
              ],
              "replyKeywords": [
                "example string"
              ]
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {},
            "conditions": { }
          }
        ]
      ],
      "action": [
        [
          {
            "type": "string",
            "info": {
              "journeyId": "string",
              "doNotRestart": "boolean"
            }
          },
          {
            "type": "string",
            "info": {
              "journeyId": "string"
            }
          },
          {
            "type": "string",
            "info": { }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "tags": {
                "qualifier": "string",
                "values": [
                  "example string"
                ]
              }
            }
          },
          {
            "type": "string",
            "info": { }
          },
          {
            "type": "string",
            "info": { }
          }
        ]
      ],
      "status": "string",
      "enduserCondition?": [
        [
          { },
          { "key": string }
        ]
      ],
      "journeyId?": "string",
      "oncePerEnduser?": "boolean",
      "triggerNextAt?": "Date"
    }
  ]
}

Update AutomationTrigger

Method: PATCH

https://api.tellescope.com/v1/automation-trigger/:id

Updates AutomationTrigger fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "event?": [
      [
        {
          "type": "string",
          "info": {
            "formId": "string",
            "publicIdentifier": "string",
            "submitterType": "string"
          },
          "conditions": [
            [
              { },
              { "key": string }
            ]
          ]
        },
        {
          "type": "string",
          "info": {
            "formId": "string",
            "intervalInMS": "number"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "field": "string",
            "value": "string"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "intervalInMS": "number",
            "templateIds": [
              "example string"
            ],
            "titles": [
              "example string"
            ]
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": { },
          "conditions": { }
        },
        {
          "type": "string",
          "info": { },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "titles": [
              "example string"
            ]
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "titles": [
              "example string"
            ]
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "minutes": "number"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "intervalInMS": "number"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "minutes": "number",
            "units": [
              "example string"
            ],
            "comparison": [
              [
                {
                  "type": "string",
                  "value": "number"
                },
                {
                  "type": "string",
                  "value": "number"
                },
                {
                  "type": "string",
                  "value": {
                    "lower": "number",
                    "upper": "number"
                  }
                }
              ]
            ],
            "periodInMS": "number"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "configurationIds": [
              "60398b0231a295e64f084fd9"
            ],
            "classifications": [
              "example string"
            ]
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "templateIds": [
              "60398b0231a295e64f084fd9"
            ],
            "replyKeywords": [
              "example string"
            ]
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {},
          "conditions": { }
        }
      ]
    ],
    "action?": [
      [
        {
          "type": "string",
          "info": {
            "journeyId": "string",
            "doNotRestart": "boolean"
          }
        },
        {
          "type": "string",
          "info": {
            "journeyId": "string"
          }
        },
        {
          "type": "string",
          "info": { }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "tags": {
              "qualifier": "string",
              "values": [
                "example string"
              ]
            }
          }
        },
        {
          "type": "string",
          "info": { }
        },
        {
          "type": "string",
          "info": { }
        }
      ]
    ],
    "status?": "string",
    "enduserCondition?": [
      [
        { },
        { "key": string }
      ]
    ],
    "journeyId?": "string",
    "oncePerEnduser?": "boolean",
    "triggerNextAt?": "Date"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get AutomationTrigger

Method: GET

https://api.tellescope.com/v1/automation-trigger/:id

Get an AutomationTrigger

{
  "filter?": {}
}

Get AutomationTriggers

Method: GET

https://api.tellescope.com/v1/automation-triggers

Get a page of AutomationTriggers

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete AutomationTrigger

Method: DELETE

https://api.tellescope.com/v1/automation-trigger/:id

Delete one AutomationTrigger

Authentication info only

AvailabilityBlocks

Update order of availability blocks

Method: POST

https://api.tellescope.com/v1/update-order-of-availability-blocks

Returns a computed result for an analytics query

{
  "indexUpdates": [
    {
      "id": "60398b0231a295e64f084fd9",
      "index": 0
    }
  ]
}

Handle Autoreply (Admin Only)

Method: POST

https://api.tellescope.com/v1/handle-out-of-office-autoreply

Handles autoreply during out-of-office periods, throttled to one message per hour

{
  "channel": "string",
  "enduserId": "string",
  "threadId?": "string",
  "userId?": "string"
}

Create AvailabilityBlock

Method: POST

https://api.tellescope.com/v1/availability-block

Creates a new AvailabilityBlock

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "entity": "string",
  "entityId": "string",
  "index": "number",
  "dayOfWeekStartingSundayIndexedByZero": "number",
  "startTimeInMinutes": "number",
  "endTimeInMinutes": "number",
  "active?": {
    "from": "Date",
    "to": "Date"
  }
}

Create AvailabilityBlocks

Method: POST

https://api.tellescope.com/v1/availability-blocks

Creates new AvailabilityBlocks

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "entity": "string",
      "entityId": "string",
      "index": "number",
      "dayOfWeekStartingSundayIndexedByZero": "number",
      "startTimeInMinutes": "number",
      "endTimeInMinutes": "number",
      "active?": {
        "from": "Date",
        "to": "Date"
      }
    }
  ]
}

Update AvailabilityBlock

Method: PATCH

https://api.tellescope.com/v1/availability-block/:id

Updates AvailabilityBlock fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "entity?": "string",
    "entityId?": "string",
    "index?": "number",
    "dayOfWeekStartingSundayIndexedByZero?": "number",
    "startTimeInMinutes?": "number",
    "endTimeInMinutes?": "number",
    "active?": {
      "from": "Date",
      "to": "Date"
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get AvailabilityBlock

Method: GET

https://api.tellescope.com/v1/availability-block/:id

Get an AvailabilityBlock

{
  "filter?": {}
}

Get AvailabilityBlocks

Method: GET

https://api.tellescope.com/v1/availability-blocks

Get a page of AvailabilityBlocks

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete AvailabilityBlock

Method: DELETE

https://api.tellescope.com/v1/availability-block/:id

Delete one AvailabilityBlock

Authentication info only

BackgroundErrors

Create BackgroundError

Method: POST

https://api.tellescope.com/v1/background-error

Creates a new BackgroundError

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "message": "string",
  "acknowledgedAt?": "Date",
  "journeyId?": "string",
  "enduserId?": "string"
}

Create BackgroundErrors

Method: POST

https://api.tellescope.com/v1/background-errors

Creates new BackgroundErrors

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "message": "string",
      "acknowledgedAt?": "Date",
      "journeyId?": "string",
      "enduserId?": "string"
    }
  ]
}

Update BackgroundError

Method: PATCH

https://api.tellescope.com/v1/background-error/:id

Updates BackgroundError fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "message?": "string",
    "acknowledgedAt?": "Date",
    "journeyId?": "string",
    "enduserId?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get BackgroundError

Method: GET

https://api.tellescope.com/v1/background-error/:id

Get an BackgroundError

{
  "filter?": {}
}

Get BackgroundErrors

Method: GET

https://api.tellescope.com/v1/background-errors

Get a page of BackgroundErrors

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete BackgroundError

Method: DELETE

https://api.tellescope.com/v1/background-error/:id

Delete one BackgroundError

Authentication info only

BlockedPhones

Constraints

  • phone must be unique across BlockedPhones

Create BlockedPhone

Method: POST

https://api.tellescope.com/v1/blocked-phone

Creates a new BlockedPhone

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "phone": "string"
}

Create BlockedPhones

Method: POST

https://api.tellescope.com/v1/blocked-phones

Creates new BlockedPhones

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "phone": "string"
    }
  ]
}

Update BlockedPhone

Method: PATCH

https://api.tellescope.com/v1/blocked-phone/:id

Updates BlockedPhone fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "phone?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get BlockedPhone

Method: GET

https://api.tellescope.com/v1/blocked-phone/:id

Get an BlockedPhone

{
  "filter?": {}
}

Get BlockedPhones

Method: GET

https://api.tellescope.com/v1/blocked-phones

Get a page of BlockedPhones

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete BlockedPhone

Method: DELETE

https://api.tellescope.com/v1/blocked-phone/:id

Delete one BlockedPhone

Authentication info only

CalendarEventRSVPs

Constraints

  • All of [eventId, creator] must be unique for each CalendarEventRSVPs

Create CalendarEventRSVP

Method: POST

https://api.tellescope.com/v1/calendar-event-RSVP

Creates a new CalendarEventRSVP

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "eventId": "string",
  "displayName?": "string",
  "avatar?": "string",
  "status?": "string"
}

Create CalendarEventRSVPs

Method: POST

https://api.tellescope.com/v1/calendar-event-RSVPs

Creates new CalendarEventRSVPs

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "eventId": "string",
      "displayName?": "string",
      "avatar?": "string",
      "status?": "string"
    }
  ]
}

Update CalendarEventRSVP

Method: PATCH

https://api.tellescope.com/v1/calendar-event-RSVP/:id

Updates CalendarEventRSVP fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "eventId?": "string",
    "displayName?": "string",
    "avatar?": "string",
    "status?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get CalendarEventRSVP

Method: GET

https://api.tellescope.com/v1/calendar-event-RSVP/:id

Get an CalendarEventRSVP

{
  "filter?": {}
}

Get CalendarEventRSVPs

Method: GET

https://api.tellescope.com/v1/calendar-event-RSVPs

Get a page of CalendarEventRSVPs

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete CalendarEventRSVP

Method: DELETE

https://api.tellescope.com/v1/calendar-event-RSVP/:id

Delete one CalendarEventRSVP

Authentication info only

CalendarEvents

Constraints

  • enduser cannot update public events

Generate Session for Public Appointment Booking (Public)

Method: POST

https://api.tellescope.com/v1/session-for-public-appointment-booking

Generates a session for booking an appointment

{
  "email": "string",
  "calendarEventTemplateId": "string",
  "businessId": "string",
  "dateOfBirth?": "string",
  "phone?": "string",
  "fname?": "string",
  "lname?": "string",
  "state?": "string",
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ]
}

Gets Appointment Booking Details (Public)

Method: GET

https://api.tellescope.com/v1/details-for-appointment-booking-page

Gets details related to booking an appointment

{
  "appointmentBookingPageId": "string",
  "businessId": "string",
  "userId?": "string",
  "userTags?": [
    "example string"
  ],
  "userFilterTags?": [
    "example string"
  ]
}

Get Events for User (Including Integrations)

Method: GET

https://api.tellescope.com/v1/events-for-user

Combines internal and external events, formatted as a Tellescope events

{
  "userId": "string",
  "from": "Date",
  "to?": "Date",
  "limit?": "number"
}

Load Events

Method: GET

https://api.tellescope.com/v1/calendar-events/load-events

For loading Tellescope events across multiple users for a given time period

{
  "userIds": [
    "example string"
  ],
  "from": "Date",
  "to": "Date",
  "limit?": "number",
  "external?": "boolean"
}

Generate Meeting Link

Method: POST

https://api.tellescope.com/v1/generate-meeting-link

Generates a link to join a scheduled meeting for an enduser

{
  "eventId": "string",
  "enduserId": "string"
}

Get Appointment Availability for a Calendar Event Type

Method: GET

https://api.tellescope.com/v1/calendar-availability

Gets availability blocks for different users based on their internal and external calendars

  • The limit parameter indicates the number of future calendar event conflicts to look up when determining availability. This defaults to a high value (500) and should only be reduced with caution.
{
  "calendarEventTemplateId": "string",
  "from": "Date",
  "locationId?": "string",
  "restrictedByState?": "boolean",
  "multi?": "boolean",
  "to?": "Date",
  "limit?": "number",
  "businessId?": "string",
  "userId?": "string",
  "userIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "intervalInMinutes?": "number"
}

Book Appointment

Method: POST

https://api.tellescope.com/v1/book-appointment

Books an appointment with a given user if available

{
  "calendarEventTemplateId": "string",
  "userId": "string",
  "otherUserIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "startTime": "Date",
  "locationId?": "string",
  "rescheduledCalendarEventId?": "string",
  "bookingPageId?": "string",
  "agreedToTerms?": [
    {
      "link": "example string",
      "title": "example string"
    }
  ],
  "timezone?": "string",
  "fields?": { "key": string },
  "token?": "string",
  "intervalInMinutes?": "number"
}

Get Stripe Details

Method: GET

https://api.tellescope.com/v1/scheduling/stripe-details

Gets Stripe checkout details for an appointment booking flor

Authentication info only

Generate Zoom Meeting

Method: POST

https://api.tellescope.com/v1/generate-zoom-meeting

Generates a Zoom meeting for including in a Calendar Event

{
  "calendarEventId": "string",
  "userId": "string"
}

Update Zoom Meeting Host

Method: POST

https://api.tellescope.com/v1/change-zoom-host

Updates the host for an existing Zoom meeting

{
  "calendarEventId": "string",
  "userId": "string"
}

Download ICS file

Method: GET

https://api.tellescope.com/v1/calendar-events/download-ics-file

A URL which triggers the download of an ICS file for a given event

{
  "calendarEventId": "string",
  "attendeeId?": "string",
  "attendeeType?": "string",
  "excludeAttendee?": "boolean"
}

Report

Method: ALL

https://api.tellescope.com/v1/calendar-events/report

Builds a report

{
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "templateIds?": [
    "example string"
  ],
  "groupBy?": "string"
}

Report

Method: ALL

https://api.tellescope.com/v1/calendar-events/enduser-report

Builds a report

{
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "templateIds?": [
    "example string"
  ],
  "groupBy?": "string",
  "enduserGroupBy?": "string",
  "countDuplicates?": "boolean",
  "enduserFields?": { "key": string }
}

Create CalendarEvent

Method: POST

https://api.tellescope.com/v1/calendar-event

Creates a new CalendarEvent

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "startTimeInMS": "number",
  "durationInMinutes": "number",
  "locationId?": "string",
  "locationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "description?": "string",
  "agreedToTerms?": [
    {
      "link": "example string",
      "title": "example string"
    }
  ],
  "bookingPageId?": "string",
  "meetingStatus?": "string",
  "attachments?": [
    {
      "displayName": "example string",
      "fileId": "60398b0231a295e64f084fd9",
      "type": "example string",
      "secureName": "example string"
    }
  ],
  "cancelledAt?": "Date",
  "rescheduledAt?": "Date",
  "noShowedAt?": "Date",
  "rescheduledTo?": "string",
  "chatRoomId?": "string",
  "carePlanId?": "string",
  "carePlanNote?": "string",
  "attendees?": [
    {
      "type": "user",
      "id": "60398b0231a295e64f084fd9"
    }
  ],
  "reminders?": [
    {
      "info": {},
      "type": "webhook",
      "msBeforeStartTime": -10000000000000,
      "didRemind": true
    }
  ],
  "templateId?": "string",
  "publicRead?": "boolean",
  "wasSelfScheduled?": "boolean",
  "enableVideoCall?": "boolean",
  "fields?": {},
  "numRSVPs?": "number",
  "image?": "string",
  "sharedContentIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "enduserFormResponses?": [
    {
      "enduserId": "60398b0231a295e64f084fd9",
      "formId": "60398b0231a295e64f084fd9",
      "accessCode": "example string"
    }
  ],
  "enduserTasks?": [
    {
      "id": "60398b0231a295e64f084fd9",
      "enduserId": "60398b0231a295e64f084fd9"
    }
  ],
  "color?": "string",
  "location?": "string",
  "locationURL?": "string",
  "locationNotes?": "string",
  "portalSettings?": {
    "hideUsers": "boolean"
  },
  "externalId?": "string",
  "source?": "string",
  "videoIntegration?": "string",
  "videoURL?": "string",
  "timezone?": "string",
  "copiedFrom?": "string",
  "internalNotes?": "string",
  "hiddenFromPortal?": "boolean",
  "enduserAttendeeLimit?": "number",
  "bufferEndMinutes?": "number",
  "bufferStartMinutes?": "number",
  "canvasCoding?": {
    "code": "string",
    "display": "string",
    "system": "string"
  }
}

Create CalendarEvents

Method: POST

https://api.tellescope.com/v1/calendar-events

Creates new CalendarEvents

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "startTimeInMS": "number",
      "durationInMinutes": "number",
      "locationId?": "string",
      "locationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "description?": "string",
      "agreedToTerms?": [
        {
          "link": "example string",
          "title": "example string"
        }
      ],
      "bookingPageId?": "string",
      "meetingStatus?": "string",
      "attachments?": [
        {
          "displayName": "example string",
          "fileId": "60398b0231a295e64f084fd9",
          "type": "example string",
          "secureName": "example string"
        }
      ],
      "cancelledAt?": "Date",
      "rescheduledAt?": "Date",
      "noShowedAt?": "Date",
      "rescheduledTo?": "string",
      "chatRoomId?": "string",
      "carePlanId?": "string",
      "carePlanNote?": "string",
      "attendees?": [
        {
          "type": "user",
          "id": "60398b0231a295e64f084fd9"
        }
      ],
      "reminders?": [
        {
          "info": {},
          "type": "webhook",
          "msBeforeStartTime": -10000000000000,
          "didRemind": true
        }
      ],
      "templateId?": "string",
      "publicRead?": "boolean",
      "wasSelfScheduled?": "boolean",
      "enableVideoCall?": "boolean",
      "fields?": {},
      "numRSVPs?": "number",
      "image?": "string",
      "sharedContentIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "enduserFormResponses?": [
        {
          "enduserId": "60398b0231a295e64f084fd9",
          "formId": "60398b0231a295e64f084fd9",
          "accessCode": "example string"
        }
      ],
      "enduserTasks?": [
        {
          "id": "60398b0231a295e64f084fd9",
          "enduserId": "60398b0231a295e64f084fd9"
        }
      ],
      "color?": "string",
      "location?": "string",
      "locationURL?": "string",
      "locationNotes?": "string",
      "portalSettings?": {
        "hideUsers": "boolean"
      },
      "externalId?": "string",
      "source?": "string",
      "videoIntegration?": "string",
      "videoURL?": "string",
      "timezone?": "string",
      "copiedFrom?": "string",
      "internalNotes?": "string",
      "hiddenFromPortal?": "boolean",
      "enduserAttendeeLimit?": "number",
      "bufferEndMinutes?": "number",
      "bufferStartMinutes?": "number",
      "canvasCoding?": {
        "code": "string",
        "display": "string",
        "system": "string"
      }
    }
  ]
}

Update CalendarEvent

Method: PATCH

https://api.tellescope.com/v1/calendar-event/:id

Updates CalendarEvent fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "startTimeInMS?": "number",
    "durationInMinutes?": "number",
    "locationId?": "string",
    "locationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "description?": "string",
    "agreedToTerms?": [
      {
        "link": "example string",
        "title": "example string"
      }
    ],
    "bookingPageId?": "string",
    "meetingStatus?": "string",
    "attachments?": [
      {
        "displayName": "example string",
        "fileId": "60398b0231a295e64f084fd9",
        "type": "example string",
        "secureName": "example string"
      }
    ],
    "cancelledAt?": "Date",
    "rescheduledAt?": "Date",
    "noShowedAt?": "Date",
    "rescheduledTo?": "string",
    "chatRoomId?": "string",
    "carePlanId?": "string",
    "carePlanNote?": "string",
    "attendees?": [
      {
        "type": "user",
        "id": "60398b0231a295e64f084fd9"
      }
    ],
    "reminders?": [
      {
        "info": {},
        "type": "webhook",
        "msBeforeStartTime": -10000000000000,
        "didRemind": true
      }
    ],
    "templateId?": "string",
    "publicRead?": "boolean",
    "wasSelfScheduled?": "boolean",
    "enableVideoCall?": "boolean",
    "fields?": {},
    "numRSVPs?": "number",
    "image?": "string",
    "sharedContentIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "enduserFormResponses?": [
      {
        "enduserId": "60398b0231a295e64f084fd9",
        "formId": "60398b0231a295e64f084fd9",
        "accessCode": "example string"
      }
    ],
    "enduserTasks?": [
      {
        "id": "60398b0231a295e64f084fd9",
        "enduserId": "60398b0231a295e64f084fd9"
      }
    ],
    "color?": "string",
    "location?": "string",
    "locationURL?": "string",
    "locationNotes?": "string",
    "portalSettings?": {
      "hideUsers": "boolean"
    },
    "externalId?": "string",
    "source?": "string",
    "videoIntegration?": "string",
    "videoURL?": "string",
    "timezone?": "string",
    "copiedFrom?": "string",
    "internalNotes?": "string",
    "hiddenFromPortal?": "boolean",
    "enduserAttendeeLimit?": "number",
    "bufferEndMinutes?": "number",
    "bufferStartMinutes?": "number",
    "canvasCoding?": {
      "code": "string",
      "display": "string",
      "system": "string"
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get CalendarEvent

Method: GET

https://api.tellescope.com/v1/calendar-event/:id

Get an CalendarEvent

{
  "filter?": {}
}

Get CalendarEvents

Method: GET

https://api.tellescope.com/v1/calendar-events

Get a page of CalendarEvents

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete CalendarEvent

Method: DELETE

https://api.tellescope.com/v1/calendar-event/:id

Delete one CalendarEvent

Authentication info only

CalendarEventTemplates

Constraints

  • title must be unique across CalendarEventTemplates

Create CalendarEventTemplate

Method: POST

https://api.tellescope.com/v1/calendar-event-template

Creates a new CalendarEventTemplate

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "durationInMinutes": "number",
  "portalSettings?": {
    "hideUsers": "boolean"
  },
  "productIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "description?": "string",
  "reminders?": [
    {
      "info": {},
      "type": "webhook",
      "msBeforeStartTime": -10000000000000,
      "didRemind": true
    }
  ],
  "publicRead?": "boolean",
  "enableVideoCall?": "boolean",
  "enableSelfScheduling?": "boolean",
  "restrictedByState?": "boolean",
  "image?": "string",
  "confirmationEmailDisabled?": "boolean",
  "confirmationSMSDisabled?": "boolean",
  "carePlanForms?": [
    "60398b0231a295e64f084fd9"
  ],
  "carePlanContent?": [
    "60398b0231a295e64f084fd9"
  ],
  "carePlanFiles?": [
    "60398b0231a295e64f084fd9"
  ],
  "carePlanTasks?": [
    "example string"
  ],
  "videoIntegration?": "string",
  "color?": "string",
  "apiOnly?": "boolean",
  "enduserAttendeeLimit?": "number",
  "bufferEndMinutes?": "number",
  "bufferStartMinutes?": "number",
  "canvasCoding?": {
    "code": "string",
    "display": "string",
    "system": "string"
  },
  "tags?": [
    "example string"
  ]
}

Create CalendarEventTemplates

Method: POST

https://api.tellescope.com/v1/calendar-event-templates

Creates new CalendarEventTemplates

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "durationInMinutes": "number",
      "portalSettings?": {
        "hideUsers": "boolean"
      },
      "productIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "description?": "string",
      "reminders?": [
        {
          "info": {},
          "type": "webhook",
          "msBeforeStartTime": -10000000000000,
          "didRemind": true
        }
      ],
      "publicRead?": "boolean",
      "enableVideoCall?": "boolean",
      "enableSelfScheduling?": "boolean",
      "restrictedByState?": "boolean",
      "image?": "string",
      "confirmationEmailDisabled?": "boolean",
      "confirmationSMSDisabled?": "boolean",
      "carePlanForms?": [
        "60398b0231a295e64f084fd9"
      ],
      "carePlanContent?": [
        "60398b0231a295e64f084fd9"
      ],
      "carePlanFiles?": [
        "60398b0231a295e64f084fd9"
      ],
      "carePlanTasks?": [
        "example string"
      ],
      "videoIntegration?": "string",
      "color?": "string",
      "apiOnly?": "boolean",
      "enduserAttendeeLimit?": "number",
      "bufferEndMinutes?": "number",
      "bufferStartMinutes?": "number",
      "canvasCoding?": {
        "code": "string",
        "display": "string",
        "system": "string"
      },
      "tags?": [
        "example string"
      ]
    }
  ]
}

Update CalendarEventTemplate

Method: PATCH

https://api.tellescope.com/v1/calendar-event-template/:id

Updates CalendarEventTemplate fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "durationInMinutes?": "number",
    "portalSettings?": {
      "hideUsers": "boolean"
    },
    "productIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "description?": "string",
    "reminders?": [
      {
        "info": {},
        "type": "webhook",
        "msBeforeStartTime": -10000000000000,
        "didRemind": true
      }
    ],
    "publicRead?": "boolean",
    "enableVideoCall?": "boolean",
    "enableSelfScheduling?": "boolean",
    "restrictedByState?": "boolean",
    "image?": "string",
    "confirmationEmailDisabled?": "boolean",
    "confirmationSMSDisabled?": "boolean",
    "carePlanForms?": [
      "60398b0231a295e64f084fd9"
    ],
    "carePlanContent?": [
      "60398b0231a295e64f084fd9"
    ],
    "carePlanFiles?": [
      "60398b0231a295e64f084fd9"
    ],
    "carePlanTasks?": [
      "example string"
    ],
    "videoIntegration?": "string",
    "color?": "string",
    "apiOnly?": "boolean",
    "enduserAttendeeLimit?": "number",
    "bufferEndMinutes?": "number",
    "bufferStartMinutes?": "number",
    "canvasCoding?": {
      "code": "string",
      "display": "string",
      "system": "string"
    },
    "tags?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get CalendarEventTemplate

Method: GET

https://api.tellescope.com/v1/calendar-event-template/:id

Get an CalendarEventTemplate

{
  "filter?": {}
}

Get CalendarEventTemplates

Method: GET

https://api.tellescope.com/v1/calendar-event-templates

Get a page of CalendarEventTemplates

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete CalendarEventTemplate

Method: DELETE

https://api.tellescope.com/v1/calendar-event-template/:id

Delete one CalendarEventTemplate

Authentication info only

CarePlans

Create CarePlan

Method: POST

https://api.tellescope.com/v1/care-plan

Creates a new CarePlan

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "enduserId": "string",
  "description?": "string",
  "eventIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "journeyId?": "string",
  "completedAt?": "Date",
  "htmlDescription?": "string",
  "hideRemainingTicketsProgress?": "boolean",
  "highlightedEnduserFields?": [
    "example string"
  ]
}

Create CarePlans

Method: POST

https://api.tellescope.com/v1/care-plans

Creates new CarePlans

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "enduserId": "string",
      "description?": "string",
      "eventIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "journeyId?": "string",
      "completedAt?": "Date",
      "htmlDescription?": "string",
      "hideRemainingTicketsProgress?": "boolean",
      "highlightedEnduserFields?": [
        "example string"
      ]
    }
  ]
}

Update CarePlan

Method: PATCH

https://api.tellescope.com/v1/care-plan/:id

Updates CarePlan fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "enduserId?": "string",
    "description?": "string",
    "eventIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "journeyId?": "string",
    "completedAt?": "Date",
    "htmlDescription?": "string",
    "hideRemainingTicketsProgress?": "boolean",
    "highlightedEnduserFields?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get CarePlan

Method: GET

https://api.tellescope.com/v1/care-plan/:id

Get an CarePlan

{
  "filter?": {}
}

Get CarePlans

Method: GET

https://api.tellescope.com/v1/care-plans

Get a page of CarePlans

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete CarePlan

Method: DELETE

https://api.tellescope.com/v1/care-plan/:id

Delete one CarePlan

Authentication info only

ChatMessages

Messages between users in a given Chat Room

Create Chat

Method: POST

https://api.tellescope.com/v1/chat

Creates a new Chat

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "roomId": "string",
  "senderId?": "string",
  "userId?": "string",
  "message": "string",
  "html?": "string",
  "replyId?": "string",
  "readBy?": { string: Date },
  "hiddenBy?": { string: Date },
  "attachments?": [
    {
      "name": "example string",
      "secureName": "example string"
    }
  ],
  "templateId?": "string",
  "automationStepId?": "string",
  "linkOpenTrackingIds?": [
    "example string"
  ],
  "timestamp?": "Date",
  "ticketIds?": [
    "example string"
  ],
  "tags?": [
    "example string"
  ],
  "enduserId?": "string",
  "mentions?": [
    "60398b0231a295e64f084fd9"
  ]
}

Update Chat

Method: PATCH

https://api.tellescope.com/v1/chat/:id

Updates Chat fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "senderId?": "string",
    "userId?": "string",
    "message?": "string",
    "html?": "string",
    "readBy?": { string: Date },
    "hiddenBy?": { string: Date },
    "attachments?": [
      {
        "name": "example string",
        "secureName": "example string"
      }
    ],
    "templateId?": "string",
    "automationStepId?": "string",
    "linkOpenTrackingIds?": [
      "example string"
    ],
    "timestamp?": "Date",
    "ticketIds?": [
      "example string"
    ],
    "tags?": [
      "example string"
    ],
    "enduserId?": "string",
    "mentions?": [
      "60398b0231a295e64f084fd9"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Chat

Method: GET

https://api.tellescope.com/v1/chat/:id

Get an Chat

{
  "filter?": {}
}

Get Chats

Method: GET

https://api.tellescope.com/v1/chats

Get a page of Chats

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete Chat

Method: DELETE

https://api.tellescope.com/v1/chat/:id

Delete one Chat

Authentication info only

ChatRooms

Constraints

  • Elements of userIds must be unique for each ChatRooms
  • Elements of enduserIds must be unique for each ChatRooms

Join chat room

Method: POST

https://api.tellescope.com/v1/join-chat-room

Allows a user to join a chat room with no other users, for use in accepting support chats.

{
  "id": "string"
}

Mark Read

Method: POST

https://api.tellescope.com/v1/mark-chat-room-read

Marks the conversation read by the authenticated user

{
  "id": "string"
}

Attendee display info

Method: GET

https://api.tellescope.com/v1/chat-room-display-info

Returns an object which maps userIds/enduserIds to display information. Includes the roomId as the 'id' field.

{
  "id": "string"
}

Create ChatRoom

Method: POST

https://api.tellescope.com/v1/chat-room

Creates a new ChatRoom

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "assignedTo?": [
    "example string"
  ],
  "numMessages?": "number",
  "recentMessageSentAt?": "number",
  "type?": "string",
  "topic?": "string",
  "description?": "string",
  "userIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "enduserIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "ticketId?": "string",
  "endedAt?": "Date",
  "tags?": [
    "example string"
  ],
  "infoForUser?": { "key": [object Object] },
  "aboutEnduserId?": "string",
  "pinnedAt?": "Date",
  "fields?": {},
  "suggestedReply?": "string"
}

Create ChatRooms

Method: POST

https://api.tellescope.com/v1/chat-rooms

Creates new ChatRooms

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "assignedTo?": [
        "example string"
      ],
      "numMessages?": "number",
      "recentMessageSentAt?": "number",
      "type?": "string",
      "topic?": "string",
      "description?": "string",
      "userIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "enduserIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "ticketId?": "string",
      "endedAt?": "Date",
      "tags?": [
        "example string"
      ],
      "infoForUser?": { "key": [object Object] },
      "aboutEnduserId?": "string",
      "pinnedAt?": "Date",
      "fields?": {},
      "suggestedReply?": "string"
    }
  ]
}

Update ChatRoom

Method: PATCH

https://api.tellescope.com/v1/chat-room/:id

Updates ChatRoom fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "assignedTo?": [
      "example string"
    ],
    "numMessages?": "number",
    "recentMessageSentAt?": "number",
    "type?": "string",
    "topic?": "string",
    "description?": "string",
    "userIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "enduserIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "ticketId?": "string",
    "endedAt?": "Date",
    "tags?": [
      "example string"
    ],
    "infoForUser?": { "key": [object Object] },
    "aboutEnduserId?": "string",
    "pinnedAt?": "Date",
    "fields?": {},
    "suggestedReply?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get ChatRoom

Method: GET

https://api.tellescope.com/v1/chat-room/:id

Get an ChatRoom

{
  "filter?": {}
}

Get ChatRooms

Method: GET

https://api.tellescope.com/v1/chat-rooms

Get a page of ChatRooms

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete ChatRoom

Method: DELETE

https://api.tellescope.com/v1/chat-room/:id

Delete one ChatRoom

Authentication info only

CommentLikes

Constraints

  • All of [commentId, creator] must be unique for each CommentLikes

Create CommentLike

Method: POST

https://api.tellescope.com/v1/comment-like

Creates a new CommentLike

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "forumId": "string",
  "postId": "string",
  "commentId": "string"
}

Get CommentLike

Method: GET

https://api.tellescope.com/v1/comment-like/:id

Get an CommentLike

{
  "filter?": {}
}

Get CommentLikes

Method: GET

https://api.tellescope.com/v1/comment-likes

Get a page of CommentLikes

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete CommentLike

Method: DELETE

https://api.tellescope.com/v1/comment-like/:id

Delete one CommentLike

Authentication info only

Configurations

Create Configuration

Method: POST

https://api.tellescope.com/v1/configuration

Creates a new Configuration

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "type?": "string",
  "value?": "string"
}

Create Configurations

Method: POST

https://api.tellescope.com/v1/configurations

Creates new Configurations

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "type?": "string",
      "value?": "string"
    }
  ]
}

Update Configuration

Method: PATCH

https://api.tellescope.com/v1/configuration/:id

Updates Configuration fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "type?": "string",
    "value?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Configuration

Method: GET

https://api.tellescope.com/v1/configuration/:id

Get an Configuration

{
  "filter?": {}
}

Get Configurations

Method: GET

https://api.tellescope.com/v1/configurations

Get a page of Configurations

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete Configuration

Method: DELETE

https://api.tellescope.com/v1/configuration/:id

Delete one Configuration

Authentication info only

DatabaseRecords

Create DatabaseRecord

Method: POST

https://api.tellescope.com/v1/database-record

Creates a new DatabaseRecord

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "databaseId": "string",
  "values": [
    {
      "type": "Text",
      "value": "example string",
      "label": "example string"
    }
  ]
}

Create DatabaseRecords

Method: POST

https://api.tellescope.com/v1/database-records

Creates new DatabaseRecords

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "databaseId": "string",
      "values": [
        {
          "type": "Text",
          "value": "example string",
          "label": "example string"
        }
      ]
    }
  ]
}

Update DatabaseRecord

Method: PATCH

https://api.tellescope.com/v1/database-record/:id

Updates DatabaseRecord fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "databaseId?": "string",
    "values?": [
      {
        "type": "Text",
        "value": "example string",
        "label": "example string"
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get DatabaseRecord

Method: GET

https://api.tellescope.com/v1/database-record/:id

Get an DatabaseRecord

{
  "filter?": {}
}

Get DatabaseRecords

Method: GET

https://api.tellescope.com/v1/database-records

Get a page of DatabaseRecords

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete DatabaseRecord

Method: DELETE

https://api.tellescope.com/v1/database-record/:id

Delete one DatabaseRecord

Authentication info only

Databases

Constraints

  • title must be unique across Databases

Create Database

Method: POST

https://api.tellescope.com/v1/database

Creates a new Database

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "fields": [
    {
      "type": "Text",
      "label": "example string",
      "hideFromTable": true,
      "wrap": "example string",
      "required": true,
      "options": {
        "width": "example string"
      }
    }
  ],
  "visibleForRoles?": [
    "example string"
  ]
}

Create Databases

Method: POST

https://api.tellescope.com/v1/databases

Creates new Databases

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "fields": [
        {
          "type": "Text",
          "label": "example string",
          "hideFromTable": true,
          "wrap": "example string",
          "required": true,
          "options": {
            "width": "example string"
          }
        }
      ],
      "visibleForRoles?": [
        "example string"
      ]
    }
  ]
}

Update Database

Method: PATCH

https://api.tellescope.com/v1/database/:id

Updates Database fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "fields?": [
      {
        "type": "Text",
        "label": "example string",
        "hideFromTable": true,
        "wrap": "example string",
        "required": true,
        "options": {
          "width": "example string"
        }
      }
    ],
    "visibleForRoles?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Database

Method: GET

https://api.tellescope.com/v1/database/:id

Get an Database

{
  "filter?": {}
}

Get Databases

Method: GET

https://api.tellescope.com/v1/databases

Get a page of Databases

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete Database

Method: DELETE

https://api.tellescope.com/v1/database/:id

Delete one Database

Authentication info only

Emails

Constraints

  • Email and email consent must be set for enduser

Sync Integrations

Method: POST

https://api.tellescope.com/v1/sync-email-integrations

Syncs email with external integrations (like Gmail) and returns any newly created messages

{
  "enduserEmail": "string",
  "allUsers?": "boolean"
}

Send Outlook Mail

Method: POST

https://api.tellescope.com/v1/deliver-email-via-outlook

Sends an email via Outlook integration without creating a record in Tellescope

  • Use Create Email instead, unless you want to avoid logging the message in Tellescope
{
  "senderId": "string",
  "message": "string",
  "replyId?": "string",
  "cc?": [
    "example string"
  ]
}

Send Email via Iterable

Method: POST

https://api.tellescope.com/v1/emails/deliver-via-iterable

Sends an email via Iterable

{
  "recipientEmail": "string",
  "campaignId": "string"
}

Send Email via Template

Method: POST

https://api.tellescope.com/v1/emails/send-with-template

Sends an email for a specific template on behalf of a user (senderId is user.id)

{
  "enduserId?": "string",
  "senderId?": "string",
  "templateId?": "string"
}

Create Email

Method: POST

https://api.tellescope.com/v1/email

Sends or logs an email

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "logOnly?": "boolean",
  "enduserId": "string",
  "userId?": "string",
  "subject": "string",
  "textContent": "string",
  "HTMLContent?": "string",
  "timestamp?": "Date",
  "replyTo?": "string",
  "inbound?": "boolean",
  "readBy?": { string: Date },
  "hiddenBy?": { string: Date },
  "templateId?": "string",
  "automationStepId?": "string",
  "linkOpenTrackingIds?": [
    "example string"
  ],
  "journeyContext?": {
    "calendarEventId": "string",
    "formResponseId": "string",
    "purchaseId": "string",
    "templateId": "string",
    "orderId": "string"
  },
  "sendAt?": "Date",
  "pinnedAt?": "Date",
  "isDraft?": "boolean",
  "cc?": [
    "example string"
  ],
  "ticketIds?": [
    "example string"
  ],
  "alternateToAddress?": "string",
  "suggestedReply?": "string",
  "tags?": [
    "example string"
  ],
  "batchId?": "string",
  "isMarketing?": "boolean",
  "assignedTo?": [
    "example string"
  ]
}

Create Emails

Method: POST

https://api.tellescope.com/v1/emails

Sends or logs multiple emails

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "logOnly?": "boolean",
      "enduserId": "string",
      "userId?": "string",
      "subject": "string",
      "textContent": "string",
      "HTMLContent?": "string",
      "timestamp?": "Date",
      "replyTo?": "string",
      "inbound?": "boolean",
      "readBy?": { string: Date },
      "hiddenBy?": { string: Date },
      "templateId?": "string",
      "automationStepId?": "string",
      "linkOpenTrackingIds?": [
        "example string"
      ],
      "journeyContext?": {
        "calendarEventId": "string",
        "formResponseId": "string",
        "purchaseId": "string",
        "templateId": "string",
        "orderId": "string"
      },
      "sendAt?": "Date",
      "pinnedAt?": "Date",
      "isDraft?": "boolean",
      "cc?": [
        "example string"
      ],
      "ticketIds?": [
        "example string"
      ],
      "alternateToAddress?": "string",
      "suggestedReply?": "string",
      "tags?": [
        "example string"
      ],
      "batchId?": "string",
      "isMarketing?": "boolean",
      "assignedTo?": [
        "example string"
      ]
    }
  ]
}

Update Email

Method: PATCH

https://api.tellescope.com/v1/email/:id

Updates Email fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "logOnly?": "boolean",
    "enduserId?": "string",
    "subject?": "string",
    "textContent?": "string",
    "HTMLContent?": "string",
    "timestamp?": "Date",
    "replyTo?": "string",
    "inbound?": "boolean",
    "readBy?": { string: Date },
    "hiddenBy?": { string: Date },
    "templateId?": "string",
    "automationStepId?": "string",
    "linkOpenTrackingIds?": [
      "example string"
    ],
    "journeyContext?": {
      "calendarEventId": "string",
      "formResponseId": "string",
      "purchaseId": "string",
      "templateId": "string",
      "orderId": "string"
    },
    "sendAt?": "Date",
    "pinnedAt?": "Date",
    "isDraft?": "boolean",
    "cc?": [
      "example string"
    ],
    "ticketIds?": [
      "example string"
    ],
    "alternateToAddress?": "string",
    "suggestedReply?": "string",
    "tags?": [
      "example string"
    ],
    "batchId?": "string",
    "isMarketing?": "boolean",
    "assignedTo?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Email

Method: GET

https://api.tellescope.com/v1/email/:id

Get an Email

{
  "filter?": {}
}

Get Emails

Method: GET

https://api.tellescope.com/v1/emails

Get a page of Emails

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete Email

Method: DELETE

https://api.tellescope.com/v1/email/:id

Delete one Email

Authentication info only

EmailSyncDenials

Constraints

  • email must be unique across EmailSyncDenials

Create EmailSyncDenial

Method: POST

https://api.tellescope.com/v1/email-sync-denial

Creates a new EmailSyncDenial

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "email": "string"
}

Create EmailSyncDenials

Method: POST

https://api.tellescope.com/v1/email-sync-denials

Creates new EmailSyncDenials

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "email": "string"
    }
  ]
}

Update EmailSyncDenial

Method: PATCH

https://api.tellescope.com/v1/email-sync-denial/:id

Updates EmailSyncDenial fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "email?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get EmailSyncDenial

Method: GET

https://api.tellescope.com/v1/email-sync-denial/:id

Get an EmailSyncDenial

{
  "filter?": {}
}

Get EmailSyncDenials

Method: GET

https://api.tellescope.com/v1/email-sync-denials

Get a page of EmailSyncDenials

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete EmailSyncDenial

Method: DELETE

https://api.tellescope.com/v1/email-sync-denial/:id

Delete one EmailSyncDenial

Authentication info only

EnduserCustomTypes

Create EnduserCustomType

Method: POST

https://api.tellescope.com/v1/enduser-custom-type

Creates a new EnduserCustomType

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "builtinFields?": [
    {
      "hidden": true,
      "required": true,
      "requireConfirmation": true
    }
  ],
  "customFields?": [
    {
      "type": "Select",
      "info": {
        "options": [
          "example string"
        ],
        "other": true
      },
      "field": "example string",
      "required": true,
      "hiddenFromProfile": true,
      "requireConfirmation": true
    }
  ]
}

Create EnduserCustomTypes

Method: POST

https://api.tellescope.com/v1/enduser-custom-types

Creates new EnduserCustomTypes

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "builtinFields?": [
        {
          "hidden": true,
          "required": true,
          "requireConfirmation": true
        }
      ],
      "customFields?": [
        {
          "type": "Select",
          "info": {
            "options": [
              "example string"
            ],
            "other": true
          },
          "field": "example string",
          "required": true,
          "hiddenFromProfile": true,
          "requireConfirmation": true
        }
      ]
    }
  ]
}

Update EnduserCustomType

Method: PATCH

https://api.tellescope.com/v1/enduser-custom-type/:id

Updates EnduserCustomType fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "builtinFields?": [
      {
        "hidden": true,
        "required": true,
        "requireConfirmation": true
      }
    ],
    "customFields?": [
      {
        "type": "Select",
        "info": {
          "options": [
            "example string"
          ],
          "other": true
        },
        "field": "example string",
        "required": true,
        "hiddenFromProfile": true,
        "requireConfirmation": true
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get EnduserCustomType

Method: GET

https://api.tellescope.com/v1/enduser-custom-type/:id

Get an EnduserCustomType

{
  "filter?": {}
}

Get EnduserCustomTypes

Method: GET

https://api.tellescope.com/v1/enduser-custom-types

Get a page of EnduserCustomTypes

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete EnduserCustomType

Method: DELETE

https://api.tellescope.com/v1/enduser-custom-type/:id

Delete one EnduserCustomType

Authentication info only

EnduserEncounters

Encounters, currently for use with Candid integration only

Create Encounter With Candid

Method: POST

https://api.tellescope.com/v1/enduser-encounters/create-candid-encounter

Creates an Encounter in Candid

{
  "encounterId": "string"
}

Create EnduserEncounter

Method: POST

https://api.tellescope.com/v1/enduser-encounter

Creates a new EnduserEncounter

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "enduserId": "string",
  "providerUserId": "string",
  "authorizedRelease": "boolean",
  "dateOfService": "string",
  "diagnoses": [
    {
      "type": "ABF",
      "code": "example string",
      "procedureCodes": [
        {
          "code": "example string",
          "quantity": -10000000000000,
          "units": "MJ"
        }
      ]
    }
  ],
  "placeOfServiceCode": "string",
  "billingProviderAddress?": {
    "city": "string",
    "state": "string",
    "lineOne": "string",
    "lineTwo": "string",
    "zipPlusFour": "string",
    "title": "string"
  },
  "serviceFacilityAddress?": {
    "city": "string",
    "state": "string",
    "lineOne": "string",
    "lineTwo": "string",
    "zipPlusFour": "string",
    "title": "string"
  }
}

Get EnduserEncounter

Method: GET

https://api.tellescope.com/v1/enduser-encounter/:id

Get an EnduserEncounter

{
  "filter?": {}
}

Get EnduserEncounters

Method: GET

https://api.tellescope.com/v1/enduser-encounters

Get a page of EnduserEncounters

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete EnduserEncounter

Method: DELETE

https://api.tellescope.com/v1/enduser-encounter/:id

Delete one EnduserEncounter

Authentication info only

EnduserMedications

Create EnduserMedication

Method: POST

https://api.tellescope.com/v1/enduser-medication

Creates a new EnduserMedication

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "title": "string",
  "calendarEventId?": "string",
  "prescribedBy?": "string",
  "prescribedAt?": "Date",
  "startedTakingAt?": "Date",
  "stoppedTakingAt?": "Date",
  "rxNormCode?": "string",
  "dispensing?": {
    "quantity": "number",
    "unit": "string"
  },
  "dosage?": {
    "value": "string",
    "unit": "string",
    "frequency": "string"
  },
  "source?": "string",
  "externalId?": "string",
  "notes?": "string"
}

Create EnduserMedications

Method: POST

https://api.tellescope.com/v1/enduser-medications

Creates new EnduserMedications

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "title": "string",
      "calendarEventId?": "string",
      "prescribedBy?": "string",
      "prescribedAt?": "Date",
      "startedTakingAt?": "Date",
      "stoppedTakingAt?": "Date",
      "rxNormCode?": "string",
      "dispensing?": {
        "quantity": "number",
        "unit": "string"
      },
      "dosage?": {
        "value": "string",
        "unit": "string",
        "frequency": "string"
      },
      "source?": "string",
      "externalId?": "string",
      "notes?": "string"
    }
  ]
}

Update EnduserMedication

Method: PATCH

https://api.tellescope.com/v1/enduser-medication/:id

Updates EnduserMedication fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "calendarEventId?": "string",
    "prescribedBy?": "string",
    "prescribedAt?": "Date",
    "startedTakingAt?": "Date",
    "stoppedTakingAt?": "Date",
    "rxNormCode?": "string",
    "dispensing?": {
      "quantity": "number",
      "unit": "string"
    },
    "dosage?": {
      "value": "string",
      "unit": "string",
      "frequency": "string"
    },
    "source?": "string",
    "externalId?": "string",
    "notes?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get EnduserMedication

Method: GET

https://api.tellescope.com/v1/enduser-medication/:id

Get an EnduserMedication

{
  "filter?": {}
}

Get EnduserMedications

Method: GET

https://api.tellescope.com/v1/enduser-medications

Get a page of EnduserMedications

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete EnduserMedication

Method: DELETE

https://api.tellescope.com/v1/enduser-medication/:id

Delete one EnduserMedication

Authentication info only

EnduserObservations

Load Enduser Observations (Vitals)

Method: GET

https://api.tellescope.com/v1/enduser-observations/load

Loads all observations between a given time period for an Enduser, including id, timestamp, measurement, and source

{
  "enduserId": "string",
  "from": "Date",
  "to": "Date"
}

Acknowledge Observations (Vitals)

Method: POST

https://api.tellescope.com/v1/enduser-observations/acknowledge

Bulk acknowledge (mark reviewed) EnduserObservations

{
  "ids": [
    "60398b0231a295e64f084fd9"
  ]
}

Create EnduserObservation

Method: POST

https://api.tellescope.com/v1/enduser-observation

Creates a new EnduserObservation

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "category": "string",
  "status": "string",
  "measurement": {
    "unit": "string",
    "value": "number"
  },
  "enduserId": "string",
  "code?": "string",
  "source?": "string",
  "type?": "string",
  "notes?": "string",
  "recordedAt?": "Date",
  "timestamp?": "Date",
  "statusChangedBy?": "string",
  "beforeMeal?": "boolean"
}

Create EnduserObservations

Method: POST

https://api.tellescope.com/v1/enduser-observations

Creates new EnduserObservations

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "category": "string",
      "status": "string",
      "measurement": {
        "unit": "string",
        "value": "number"
      },
      "enduserId": "string",
      "code?": "string",
      "source?": "string",
      "type?": "string",
      "notes?": "string",
      "recordedAt?": "Date",
      "timestamp?": "Date",
      "statusChangedBy?": "string",
      "beforeMeal?": "boolean"
    }
  ]
}

Update EnduserObservation

Method: PATCH

https://api.tellescope.com/v1/enduser-observation/:id

Updates EnduserObservation fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "category?": "string",
    "status?": "string",
    "measurement?": {
      "unit": "string",
      "value": "number"
    },
    "enduserId?": "string",
    "code?": "string",
    "source?": "string",
    "type?": "string",
    "notes?": "string",
    "recordedAt?": "Date",
    "timestamp?": "Date",
    "statusChangedBy?": "string",
    "beforeMeal?": "boolean"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get EnduserObservation

Method: GET

https://api.tellescope.com/v1/enduser-observation/:id

Get an EnduserObservation

{
  "filter?": {}
}

Get EnduserObservations

Method: GET

https://api.tellescope.com/v1/enduser-observations

Get a page of EnduserObservations

{
  "lastId?": "string",
  "limit?": "number",
  "sort?": "'oldFirst' | 'newFirst'",
  "search?": { \n            query: string,\n          },
  "filter?": {}
}

Delete EnduserObservation

Method: DELETE

https://api.tellescope.com/v1/enduser-observation/:id

Delete one EnduserObservation

Authentication info only

EnduserOrders

Lab, medication, and device orders

Get Available Tests

Method: GET

https://api.tellescope.com/v1/enduser-orders/get-available-tests

Gets available tests (Vital). If zipCode is provided, filters by availability.

{
  "zipCode?": "string",
  "teamId?": "string"
}

Place Smart Meter Order

Method: POST

https://api.tellescope.com/v1/enduser-orders/create-smart-meter-order

Creates a Smart Meter Order

{
  "enduserId": "string",
  "lines": [
    {
      "quantity": 0,
      "sku": "example string"
    }
  ],
  "shipping?": "string"
}

Create Lab Order (Vital)

Method: POST

https://api.tellescope.com/v1/enduser-orders/create-lab-order

Creates a lab order via Vital

{
  "enduserId": "string",
  "labTestId": "string",
  "physicianUserId?": "string",
  "teamId?": "string"
}

Create Prescription Vet Order (GoGoMeds)

Method: POST

https://api.tellescope.com/v1/enduser-orders/create-gogomeds-order

Creates a vet order via GoGoMeds

{
  "enduserId": "string",
  "PrescriptionImage": "string",
  "title?": "string",
  "PetName": "string",
  "PetTypeId": "number",
  "OtherPetType?": "string",
  "PetWeight?": "string",
  "AllergyText?": "string",
  "CurrentMedications?": "string",
  "Gender": "string",
  "MedicalConditionText?": "string"
}