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.

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

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}

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-03-29T07:14:28.695Z",
                "to": "2024-03-29T07:14:28.695Z"
              }
            }
          ],
          "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": {
          "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": {},
        "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"
        }
      }
    ]
  ],
  "createdRange?": {
    "from": "Date",
    "to": "Date"
  },
  "updatedRange?": {
    "from": "Date",
    "to": "Date"
  }
}

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-03-29T07:14:28.695Z",
                "to": "2024-03-29T07:14:28.695Z"
              }
            }
          ],
          "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": {
          "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": {},
        "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"
        }
      }
    ]
  ],
  "createdRange?": {
    "from": "Date",
    "to": "Date"
  },
  "updatedRange?": {
    "from": "Date",
    "to": "Date"
  },
  "parentFrame?": "string",
  "type?": "string",
  "groupMin?": "number",
  "groupMax?": "number"
}

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-03-29T07:14:28.695Z",
                    "to": "2024-03-29T07:14:28.695Z"
                  }
                }
              ],
              "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": {
              "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": {},
            "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"
            }
          }
        ]
      ],
      "createdRange?": {
        "from": "Date",
        "to": "Date"
      },
      "updatedRange?": {
        "from": "Date",
        "to": "Date"
      },
      "parentFrame?": "string",
      "type?": "string",
      "groupMin?": "number",
      "groupMax?": "number"
    }
  ]
}

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-03-29T07:14:28.695Z",
                  "to": "2024-03-29T07:14:28.695Z"
                }
              }
            ],
            "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": {
            "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": {},
          "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"
          }
        }
      ]
    ],
    "createdRange?": {
      "from": "Date",
      "to": "Date"
    },
    "updatedRange?": {
      "from": "Date",
      "to": "Date"
    },
    "parentFrame?": "string",
    "type?": "string",
    "groupMin?": "number",
    "groupMax?": "number"
  },
  "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"
}

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"
    }
  ]
}

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"
  },
  "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"
}

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"
    }
  ]
}

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"
  },
  "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"
              }
            }
          ],
          "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"
              }
            }
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "automationStepId": "string",
          "delayInMS": "number",
          "delay": "number",
          "unit": "string",
          "cancelConditions": [
            {
              "type": "formResponse",
              "info": {
                "automationStepId": "60398b0231a295e64f084fd9"
              }
            }
          ]
        }
      },
      {
        "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"
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "templateId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "templateId": "string",
          "forAssigned": "boolean",
          "roles": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "formId": "string",
          "channel": "string"
        }
      },
      {
        "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": {}
              }
            ]
          ],
          "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-03-29T07:14:28.674Z"
            }
          ],
          "dueDateOffsetInMS": "number",
          "closeOnFinishedActions": "boolean",
          "requireConfirmation": "boolean",
          "reminders": [
            {
              "msBeforeDueDate": -10000000000000,
              "didRemind": true
            }
          ],
          "priority": "number"
        }
      },
      {
        "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": {
          "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": {}
      }
    ]
  ],
  "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"
                  }
                }
              ],
              "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"
                  }
                }
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "automationStepId": "string",
              "delayInMS": "number",
              "delay": "number",
              "unit": "string",
              "cancelConditions": [
                {
                  "type": "formResponse",
                  "info": {
                    "automationStepId": "60398b0231a295e64f084fd9"
                  }
                }
              ]
            }
          },
          {
            "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"
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "templateId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "templateId": "string",
              "forAssigned": "boolean",
              "roles": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "formId": "string",
              "channel": "string"
            }
          },
          {
            "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": {}
                  }
                ]
              ],
              "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-03-29T07:14:28.674Z"
                }
              ],
              "dueDateOffsetInMS": "number",
              "closeOnFinishedActions": "boolean",
              "requireConfirmation": "boolean",
              "reminders": [
                {
                  "msBeforeDueDate": -10000000000000,
                  "didRemind": true
                }
              ],
              "priority": "number"
            }
          },
          {
            "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": {
              "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": {}
          }
        ]
      ],
      "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"
                }
              }
            ],
            "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"
                }
              }
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "automationStepId": "string",
            "delayInMS": "number",
            "delay": "number",
            "unit": "string",
            "cancelConditions": [
              {
                "type": "formResponse",
                "info": {
                  "automationStepId": "60398b0231a295e64f084fd9"
                }
              }
            ]
          }
        },
        {
          "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"
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "templateId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "templateId": "string",
            "forAssigned": "boolean",
            "roles": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "formId": "string",
            "channel": "string"
          }
        },
        {
          "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": {}
                }
              ]
            ],
            "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-03-29T07:14:28.674Z"
              }
            ],
            "dueDateOffsetInMS": "number",
            "closeOnFinishedActions": "boolean",
            "requireConfirmation": "boolean",
            "reminders": [
              {
                "msBeforeDueDate": -10000000000000,
                "didRemind": true
              }
            ],
            "priority": "number"
          }
        },
        {
          "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": {
            "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": {}
        }
      ]
    ],
    "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"
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "templateId": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "templateId": "string",
          "forAssigned": "boolean",
          "roles": [
            "example string"
          ]
        }
      },
      {
        "type": "string",
        "info": {
          "senderId": "string",
          "formId": "string",
          "channel": "string"
        }
      },
      {
        "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": {}
              }
            ]
          ],
          "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-03-29T07:14:28.673Z"
            }
          ],
          "dueDateOffsetInMS": "number",
          "closeOnFinishedActions": "boolean",
          "requireConfirmation": "boolean",
          "reminders": [
            {
              "msBeforeDueDate": -10000000000000,
              "didRemind": true
            }
          ],
          "priority": "number"
        }
      },
      {
        "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": {
          "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": {}
      }
    ]
  ],
  "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"
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "templateId": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "templateId": "string",
              "forAssigned": "boolean",
              "roles": [
                "example string"
              ]
            }
          },
          {
            "type": "string",
            "info": {
              "senderId": "string",
              "formId": "string",
              "channel": "string"
            }
          },
          {
            "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": {}
                  }
                ]
              ],
              "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-03-29T07:14:28.673Z"
                }
              ],
              "dueDateOffsetInMS": "number",
              "closeOnFinishedActions": "boolean",
              "requireConfirmation": "boolean",
              "reminders": [
                {
                  "msBeforeDueDate": -10000000000000,
                  "didRemind": true
                }
              ],
              "priority": "number"
            }
          },
          {
            "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": {
              "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": {}
          }
        ]
      ],
      "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"
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "templateId": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "templateId": "string",
            "forAssigned": "boolean",
            "roles": [
              "example string"
            ]
          }
        },
        {
          "type": "string",
          "info": {
            "senderId": "string",
            "formId": "string",
            "channel": "string"
          }
        },
        {
          "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": {}
                }
              ]
            ],
            "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-03-29T07:14:28.673Z"
              }
            ],
            "dueDateOffsetInMS": "number",
            "closeOnFinishedActions": "boolean",
            "requireConfirmation": "boolean",
            "reminders": [
              {
                "msBeforeDueDate": -10000000000000,
                "didRemind": true
              }
            ],
            "priority": "number"
          }
        },
        {
          "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": {
            "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": {}
        }
      ]
    ],
    "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": { },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "titles": [
            "example string"
          ]
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "minutes": "number"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "intervalInMS": "number"
        },
        "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": { },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "titles": [
                "example string"
              ]
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "minutes": "number"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "intervalInMS": "number"
            },
            "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": { },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "titles": [
              "example string"
            ]
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "minutes": "number"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "intervalInMS": "number"
          },
          "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

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"
}

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"
}

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"
    }
  ]
}

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"
  },
  "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"
}

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"
    }
  ]
}

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"
  },
  "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"
}

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"
  },
  "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"
    ]
  ],
  "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"
        ]
      ],
      "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"
      ]
    ],
    "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,
      "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,
          "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,
        "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"
  },
  "sendAt?": "Date",
  "pinnedAt?": "Date",
  "isDraft?": "boolean",
  "cc?": [
    "example string"
  ],
  "ticketIds?": [
    "example string"
  ],
  "alternateToAddress?": "string",
  "suggestedReply?": "string",
  "tags?": [
    "example string"
  ],
  "batchId?": "string",
  "isMarketing?": "boolean"
}

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"
      },
      "sendAt?": "Date",
      "pinnedAt?": "Date",
      "isDraft?": "boolean",
      "cc?": [
        "example string"
      ],
      "ticketIds?": [
        "example string"
      ],
      "alternateToAddress?": "string",
      "suggestedReply?": "string",
      "tags?": [
        "example string"
      ],
      "batchId?": "string",
      "isMarketing?": "boolean"
    }
  ]
}

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"
    },
    "sendAt?": "Date",
    "pinnedAt?": "Date",
    "isDraft?": "boolean",
    "cc?": [
      "example string"
    ],
    "ticketIds?": [
      "example string"
    ],
    "alternateToAddress?": "string",
    "suggestedReply?": "string",
    "tags?": [
      "example string"
    ],
    "batchId?": "string",
    "isMarketing?": "boolean"
  },
  "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
    }
  ]
}

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
        }
      ]
    }
  ]
}

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
      }
    ]
  },
  "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"
    }
  ],
  "placeOfServiceCode": "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

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"
}

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"
    }
  ]
}

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"
  },
  "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 orders, currently for use with Vital integration only

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"
}

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"
}

Create EnduserOrder

Method: POST

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

Creates a new EnduserOrder

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "userId?": "string",
  "title": "string",
  "status": "string"
}

Create EnduserOrders

Method: POST

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

Creates new EnduserOrders

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "userId?": "string",
      "title": "string",
      "status": "string"
    }
  ]
}

Update EnduserOrder

Method: PATCH

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

Updates EnduserOrder fields

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

Get EnduserOrder

Method: GET

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

Get an EnduserOrder

{
  "filter?": {}
}

Get EnduserOrders

Method: GET

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

Get a page of EnduserOrders

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

Delete EnduserOrder

Method: DELETE

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

Delete one EnduserOrder

Authentication info only

EnduserProfileViews

Constraints

  • title must be unique across EnduserProfileViews

Create EnduserProfileView

Method: POST

https://api.tellescope.com/v1/enduser-profile-view

Creates a new EnduserProfileView

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "blocks": [
    {
      "width": "example string",
      "type": "Field Group",
      "info": {
        "fields": [
          "example string"
        ],
        "displayFields": [
          {
            "field": "example string",
            "display": "example string"
          }
        ]
      }
    }
  ]
}

Create EnduserProfileViews

Method: POST

https://api.tellescope.com/v1/enduser-profile-views

Creates new EnduserProfileViews

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "blocks": [
        {
          "width": "example string",
          "type": "Field Group",
          "info": {
            "fields": [
              "example string"
            ],
            "displayFields": [
              {
                "field": "example string",
                "display": "example string"
              }
            ]
          }
        }
      ]
    }
  ]
}

Update EnduserProfileView

Method: PATCH

https://api.tellescope.com/v1/enduser-profile-view/:id

Updates EnduserProfileView fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "blocks?": [
      {
        "width": "example string",
        "type": "Field Group",
        "info": {
          "fields": [
            "example string"
          ],
          "displayFields": [
            {
              "field": "example string",
              "display": "example string"
            }
          ]
        }
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get EnduserProfileView

Method: GET

https://api.tellescope.com/v1/enduser-profile-view/:id

Get an EnduserProfileView

{
  "filter?": {}
}

Get EnduserProfileViews

Method: GET

https://api.tellescope.com/v1/enduser-profile-views

Get a page of EnduserProfileViews

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

Delete EnduserProfileView

Method: DELETE

https://api.tellescope.com/v1/enduser-profile-view/:id

Delete one EnduserProfileView

Authentication info only

Endusers

Used to represent patients or other endusers. See Users for managing your team member's accounts.

Constraints

  • email must be unique across Endusers
  • externalId must be unique across Endusers
  • Endusers can only access and modify their own profile
  • Enduser organizationIds can only be updated by users

Begin enduser login flow (Public)

Method: POST

https://api.tellescope.com/v1/begin-enduser-login-flow

Starts the login process for an enduser, supporting passwordless options

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

Login enduser (Public)

Method: POST

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

Generates an authentication token for access to enduser-facing endpoints

{
  "businessId": "string",
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "id?": "string",
  "phone?": "string",
  "email?": "string",
  "durationInSeconds?": "number"
}

Register as Enduser (Public)

Method: POST

https://api.tellescope.com/v1/register-as-enduser

Allows and enduser to register directly with an email and password

{
  "businessId": "string",
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "email": "string",
  "fname?": "string",
  "lname?": "string",
  "emailConsent?": "boolean",
  "termsSigned?": "Date"
}

Request Password Reset (Public)

Method: POST

https://api.tellescope.com/v1/request-enduser-password-reset

Sends a password reset email

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

Reset Password (Public)

Method: POST

https://api.tellescope.com/v1/reset-enduser-password

For a code generated by request-enduser-password-reset, sets a new password

{
  "resetToken": "string",
  "newPassword": "string",
  "businessId": "string",
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ]
}

Unsubscribe Enduser (Public)

Method: POST

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

Unsubscribes an enduser from one or more types of notifications

{
  "enduserId": "string",
  "unsubscribeFrom": [
    "example string"
  ]
}

Get OTP Methods (Public)

Method: GET

https://api.tellescope.com/v1/endusers/otp-methods

Gets a list of possible OTP methods (e.g. email or sms) to refresh a given enduser session token

{
  "token": "string"
}

Send OTP Code (Public)

Method: POST

https://api.tellescope.com/v1/endusers/send-otp-code

Sends a otp code for a given method (e.g. email or sms)

{
  "token": "string",
  "method": "string"
}

Verify Code (Public)

Method: POST

https://api.tellescope.com/v1/endusers/verify-otp-code

For a valid OTP code, returns an enduser session

{
  "token": "string",
  "code": "string"
}

Check Eligibility

Method: POST

https://api.tellescope.com/v1/endusers/check-eligibility

Checks insurance eligibility via Candid or Canvas integration

{
  "id": "string",
  "integration?": "string",
  "clearinghouse?": "string"
}

Add to journey

Method: POST

https://api.tellescope.com/v1/add-endusers-to-journey

Adds (or restarts) endusers in a journey

{
  "enduserIds": [
    "60398b0231a295e64f084fd9"
  ],
  "journeyId": "string",
  "automationStepId?": "string",
  "journeyContext?": {
    "calendarEventId": "string",
    "formResponseId": "string",
    "purchaseId": "string"
  },
  "throttle?": "boolean",
  "source?": "string"
}

Remove from Journey

Method: POST

https://api.tellescope.com/v1/remove-endusers-from-journey

Removes enduser(s) from in a journey

{
  "enduserIds": [
    "60398b0231a295e64f084fd9"
  ],
  "journeyId": "string"
}

Set enduser password

Method: POST

https://api.tellescope.com/v1/set-enduser-password

Sets (or resets) an enduser's password. Minimum length 8 characters. When called by enduser, can only be used to set initial password.

{
  "id": "string"
}

Check enduser authentication

Method: GET

https://api.tellescope.com/v1/enduser-is-authenticated

Checks the validity of an enduser's authToken

{
  "id?": "string",
  "authToken": "string"
}

Refresh enduser authentication

Method: POST

https://api.tellescope.com/v1/refresh-enduser-session

When called by an authenticated enduser, generates a new session

{
  "invalidatePreviousToken?": "boolean"
}

Generate authToken

Method: GET

https://api.tellescope.com/v1/generate-enduser-auth-token

Generates an authToken for use by an enduser. Useful for integrating a 3rd-party authentication process or creating a session for an enduser without a set password in Tellescope.

{
  "id?": "string",
  "externalId?": "string",
  "email?": "string",
  "phone?": "string",
  "durationInSeconds?": "number"
}

Logout enduser

Method: POST

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

Logs out an enduser

Authentication info only

Get session info

Method: GET

https://api.tellescope.com/v1/enduser-session-info

When called by an authenticated enduser, returns their session details

Authentication info only

Merge profiles

Method: POST

https://api.tellescope.com/v1/endusers/merge

Migrates data from a source enduser to a target enduser, and then deletes the source enduser

{
  "sourceEnduserId": "string",
  "destinationEnduserId": "string"
}

Push

Method: POST

https://api.tellescope.com/v1/endusers/push

Pushes (upserts) using some integrations, like Photon Health

{
  "enduserId": "string",
  "destinations?": [
    "example string"
  ]
}

Bulk Updates

Method: PATCH

https://api.tellescope.com/v1/endusers/bulk-update

Updates custom fields across a batch of endusers at once

{
  "ids": [
    "60398b0231a295e64f084fd9"
  ],
  "fields?": {},
  "pushTags?": [
    "example string"
  ],
  "replaceTags?": [
    "example string"
  ],
  "customTypeId?": "string",
  "updateAccessTags?": "boolean"
}

Bulk Assignment

Method: PATCH

https://api.tellescope.com/v1/endusers/bulk-assignment

Add, remove, or replace care team members for endusers based on current assignment or custom field value

  • ids added by addIds are included before ids in removeIds are removed
{
  "customTypeId?": "string",
  "addIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "removeIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "field?": "string",
  "existingFieldValue?": "string",
  "existingAssignment?": {
    "qualifier": "string",
    "values": [
      "example string"
    ]
  }
}

Report

Method: GET

https://api.tellescope.com/v1/endusers/report

Builds a report

{
  "queries": { "key": [object Object] },
  "activeSince?": "Date",
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "fields?": [
    {
      "field": "example string",
      "value": "example string"
    }
  ]
}

Get Engagement Statistics

Method: GET

https://api.tellescope.com/v1/endusers/engagement

Gets the number of active endusers over a period of time (only includes chats if enduserId is set). Uses default entity only by default

{
  "formIds?": [
    "example string"
  ],
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "customTypeId?": "string",
  "enduserFields?": [
    {
      "field": "example string",
      "value": "example string"
    }
  ],
  "groupBy?": "string"
}

Get Engagement Statistics

Method: GET

https://api.tellescope.com/v1/endusers/engagement-by-userid

Gets the number of active endusers over a period of time (only includes chats if enduserId is set). Uses default entity only by default. Groups by userId as submitter of form responses or recipient of messages.

{
  "formIds?": [
    "example string"
  ],
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "customTypeId?": "string",
  "enduserFields?": [
    {
      "field": "example string",
      "value": "example string"
    }
  ]
}

Sync historical Zendesk tickets for a given enduser

Method: POST

https://api.tellescope.com/v1/endusers/sync-zendesk

{
  "enduserId": "string"
}

Get journeys report

Method: POST

https://api.tellescope.com/v1/endusers/journeys-report

{
  "journeyId?": "string"
}

Create Enduser

Method: POST

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

Creates a new Enduser

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "externalId?": "string",
  "email?": "string",
  "unsubscribedFromMarketing?": "boolean",
  "alternateEmails?": [
    "example@tellescope.com"
  ],
  "alternatePhones?": [
    "example string"
  ],
  "emailConsent?": "boolean",
  "phone?": "string",
  "landline?": "string",
  "phoneConsent?": "boolean",
  "fname?": "string",
  "mname?": "string",
  "lname?": "string",
  "dateOfBirth?": "string",
  "journeys?": {
    "string": "string"
  },
  "scheduledJourneys?": [
    {
      "journeyId": "60398b0231a295e64f084fd9",
      "addAt": "2024-03-29T07:14:28.654Z"
    }
  ],
  "tags?": [
    "example string"
  ],
  "accessTags?": [
    "example string"
  ],
  "unredactedTags?": [
    "example string"
  ],
  "fields?": {},
  "unredactedFields?": {},
  "preference?": "string",
  "assignedTo?": [
    "example string"
  ],
  "unread?": "boolean",
  "lastActive?": "Date",
  "lastLogout?": "Date",
  "termsSigned?": "Date",
  "lastCommunication?": "Date",
  "avatar?": "string",
  "gender?": "string",
  "height?": {
    "value": [
      [
        "number",
        "string"
      ]
    ],
    "unit": "string"
  },
  "weight?": {
    "value": [
      [
        "number",
        "string"
      ]
    ],
    "unit": "string"
  },
  "source?": "string",
  "addressLineOne?": "string",
  "addressLineTwo?": "string",
  "city?": "string",
  "state?": "string",
  "zipCode?": "string",
  "timezone?": "string",
  "displayName?": "string",
  "unsubscribedFromPortalChatNotifications?": "boolean",
  "triggeredEvents?": { "key": number },
  "customTypeId?": "string",
  "language?": {},
  "relationships?": [
    {
      "id": "60398b0231a295e64f084fd9"
    }
  ],
  "markedReadAt?": "Date",
  "markedUnreadAt?": "Date",
  "note?": "string",
  "insurance?": {
    "memberId": "string",
    "payerId": "string",
    "payerName": "string",
    "cardFront": "string",
    "cardBack": "string",
    "relationship": "string",
    "coverageId": "string",
    "requestId": "string",
    "eligibility": "string",
    "eligibilityRanAt": "Date",
    "status": "string",
    "relationshipDetails": {
      "fname": "string",
      "lname": "string",
      "gender": "string",
      "dateOfBirth": "string"
    }
  }
}

Create Endusers

Method: POST

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

Creates new Endusers

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "externalId?": "string",
      "email?": "string",
      "unsubscribedFromMarketing?": "boolean",
      "alternateEmails?": [
        "example@tellescope.com"
      ],
      "alternatePhones?": [
        "example string"
      ],
      "emailConsent?": "boolean",
      "phone?": "string",
      "landline?": "string",
      "phoneConsent?": "boolean",
      "fname?": "string",
      "mname?": "string",
      "lname?": "string",
      "dateOfBirth?": "string",
      "journeys?": {
        "string": "string"
      },
      "scheduledJourneys?": [
        {
          "journeyId": "60398b0231a295e64f084fd9",
          "addAt": "2024-03-29T07:14:28.654Z"
        }
      ],
      "tags?": [
        "example string"
      ],
      "accessTags?": [
        "example string"
      ],
      "unredactedTags?": [
        "example string"
      ],
      "fields?": {},
      "unredactedFields?": {},
      "preference?": "string",
      "assignedTo?": [
        "example string"
      ],
      "unread?": "boolean",
      "lastActive?": "Date",
      "lastLogout?": "Date",
      "termsSigned?": "Date",
      "lastCommunication?": "Date",
      "avatar?": "string",
      "gender?": "string",
      "height?": {
        "value": [
          [
            "number",
            "string"
          ]
        ],
        "unit": "string"
      },
      "weight?": {
        "value": [
          [
            "number",
            "string"
          ]
        ],
        "unit": "string"
      },
      "source?": "string",
      "addressLineOne?": "string",
      "addressLineTwo?": "string",
      "city?": "string",
      "state?": "string",
      "zipCode?": "string",
      "timezone?": "string",
      "displayName?": "string",
      "unsubscribedFromPortalChatNotifications?": "boolean",
      "triggeredEvents?": { "key": number },
      "customTypeId?": "string",
      "language?": {},
      "relationships?": [
        {
          "id": "60398b0231a295e64f084fd9"
        }
      ],
      "markedReadAt?": "Date",
      "markedUnreadAt?": "Date",
      "note?": "string",
      "insurance?": {
        "memberId": "string",
        "payerId": "string",
        "payerName": "string",
        "cardFront": "string",
        "cardBack": "string",
        "relationship": "string",
        "coverageId": "string",
        "requestId": "string",
        "eligibility": "string",
        "eligibilityRanAt": "Date",
        "status": "string",
        "relationshipDetails": {
          "fname": "string",
          "lname": "string",
          "gender": "string",
          "dateOfBirth": "string"
        }
      }
    }
  ]
}

Update Enduser

Method: PATCH

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

Updates Enduser fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "externalId?": "string",
    "email?": "string",
    "unsubscribedFromMarketing?": "boolean",
    "alternateEmails?": [
      "example@tellescope.com"
    ],
    "alternatePhones?": [
      "example string"
    ],
    "emailConsent?": "boolean",
    "phone?": "string",
    "landline?": "string",
    "phoneConsent?": "boolean",
    "fname?": "string",
    "mname?": "string",
    "lname?": "string",
    "dateOfBirth?": "string",
    "journeys?": {
      "string": "string"
    },
    "scheduledJourneys?": [
      {
        "journeyId": "60398b0231a295e64f084fd9",
        "addAt": "2024-03-29T07:14:28.654Z"
      }
    ],
    "tags?": [
      "example string"
    ],
    "accessTags?": [
      "example string"
    ],
    "unredactedTags?": [
      "example string"
    ],
    "fields?": {},
    "unredactedFields?": {},
    "preference?": "string",
    "assignedTo?": [
      "example string"
    ],
    "unread?": "boolean",
    "lastActive?": "Date",
    "lastLogout?": "Date",
    "termsSigned?": "Date",
    "lastCommunication?": "Date",
    "avatar?": "string",
    "gender?": "string",
    "height?": {
      "value": [
        [
          "number",
          "string"
        ]
      ],
      "unit": "string"
    },
    "weight?": {
      "value": [
        [
          "number",
          "string"
        ]
      ],
      "unit": "string"
    },
    "source?": "string",
    "addressLineOne?": "string",
    "addressLineTwo?": "string",
    "city?": "string",
    "state?": "string",
    "zipCode?": "string",
    "timezone?": "string",
    "displayName?": "string",
    "unsubscribedFromPortalChatNotifications?": "boolean",
    "triggeredEvents?": { "key": number },
    "customTypeId?": "string",
    "language?": {},
    "relationships?": [
      {
        "id": "60398b0231a295e64f084fd9"
      }
    ],
    "markedReadAt?": "Date",
    "markedUnreadAt?": "Date",
    "note?": "string",
    "insurance?": {
      "memberId": "string",
      "payerId": "string",
      "payerName": "string",
      "cardFront": "string",
      "cardBack": "string",
      "relationship": "string",
      "coverageId": "string",
      "requestId": "string",
      "eligibility": "string",
      "eligibilityRanAt": "Date",
      "status": "string",
      "relationshipDetails": {
        "fname": "string",
        "lname": "string",
        "gender": "string",
        "dateOfBirth": "string"
      }
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Enduser

Method: GET

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

Get an Enduser

{
  "filter?": {}
}

Get Endusers

Method: GET

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

Get a page of Endusers

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

Delete Enduser

Method: DELETE

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

Delete one Enduser

Authentication info only

EnduserStatusUpdates

Create EnduserStatusUpdate

Method: POST

https://api.tellescope.com/v1/enduser-status-update

Creates a new EnduserStatusUpdate

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "journeyId": "string",
  "enduserId": "string",
  "status": "string"
}

Create EnduserStatusUpdates

Method: POST

https://api.tellescope.com/v1/enduser-status-updates

Creates new EnduserStatusUpdates

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

Get EnduserStatusUpdate

Method: GET

https://api.tellescope.com/v1/enduser-status-update/:id

Get an EnduserStatusUpdate

{
  "filter?": {}
}

Get EnduserStatusUpdates

Method: GET

https://api.tellescope.com/v1/enduser-status-updates

Get a page of EnduserStatusUpdates

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

Delete EnduserStatusUpdate

Method: DELETE

https://api.tellescope.com/v1/enduser-status-update/:id

Delete one EnduserStatusUpdate

Authentication info only

EnduserTasks

Create EnduserTask

Method: POST

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

Creates a new EnduserTask

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "enduserId": "string",
  "completedAt?": "Date",
  "description?": "string"
}

Create EnduserTasks

Method: POST

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

Creates new EnduserTasks

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "enduserId": "string",
      "completedAt?": "Date",
      "description?": "string"
    }
  ]
}

Update EnduserTask

Method: PATCH

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

Updates EnduserTask fields

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

Get EnduserTask

Method: GET

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

Get an EnduserTask

{
  "filter?": {}
}

Get EnduserTasks

Method: GET

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

Get a page of EnduserTasks

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

Delete EnduserTask

Method: DELETE

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

Delete one EnduserTask

Authentication info only

EnduserViews

Constraints

  • title must be unique across EnduserViews

Create EnduserView

Method: POST

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

Creates a new EnduserView

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "fields?": [
    "example string"
  ],
  "filter?": { "key": string },
  "defaultForUserIds?": [
    "example string"
  ],
  "hideProfileLink?": "boolean",
  "customTypeId?": "string",
  "style?": { "key": string },
  "sort?": [
    {
      "ascending": true,
      "field": "example string",
      "type": "date"
    }
  ]
}

Create EnduserViews

Method: POST

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

Creates new EnduserViews

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "fields?": [
        "example string"
      ],
      "filter?": { "key": string },
      "defaultForUserIds?": [
        "example string"
      ],
      "hideProfileLink?": "boolean",
      "customTypeId?": "string",
      "style?": { "key": string },
      "sort?": [
        {
          "ascending": true,
          "field": "example string",
          "type": "date"
        }
      ]
    }
  ]
}

Update EnduserView

Method: PATCH

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

Updates EnduserView fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "fields?": [
      "example string"
    ],
    "filter?": { "key": string },
    "defaultForUserIds?": [
      "example string"
    ],
    "hideProfileLink?": "boolean",
    "customTypeId?": "string",
    "style?": { "key": string },
    "sort?": [
      {
        "ascending": true,
        "field": "example string",
        "type": "date"
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get EnduserView

Method: GET

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

Get an EnduserView

{
  "filter?": {}
}

Get EnduserViews

Method: GET

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

Get a page of EnduserViews

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

Delete EnduserView

Method: DELETE

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

Delete one EnduserView

Authentication info only

EngagementEvents

Create EngagementEvent

Method: POST

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

Creates a new EngagementEvent

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "significance": "number",
  "timestamp?": "Date",
  "fields?": {}
}

Create EngagementEvents

Method: POST

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

Creates new EngagementEvents

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "significance": "number",
      "timestamp?": "Date",
      "fields?": {}
    }
  ]
}

Update EngagementEvent

Method: PATCH

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

Updates EngagementEvent fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "significance?": "number",
    "timestamp?": "Date",
    "fields?": {}
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get EngagementEvent

Method: GET

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

Get an EngagementEvent

{
  "filter?": {}
}

Get EngagementEvents

Method: GET

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

Get a page of EngagementEvents

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

Delete EngagementEvent

Method: DELETE

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

Delete one EngagementEvent

Authentication info only

Files

Prepare File Upload

Method: POST

https://api.tellescope.com/v1/prepare-file-upload

Generates an upload link for a file, storing metadata as a File record.

{
  "name": "string",
  "size": "number",
  "type": "string",
  "publicRead?": "boolean",
  "isCalledOut?": "boolean",
  "publicName?": "string",
  "enduserId?": "string"
}

Generate File Download

Method: GET

https://api.tellescope.com/v1/file-download-URL

Generates a temporary download link for a file (which expires in no more than 7 days).

{
  "secureName": "string",
  "preferInBrowser?": "boolean"
}

Get File

Method: GET

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

Get an File

{
  "filter?": {}
}

Get Files

Method: GET

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

Get a page of Files

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

Update File

Method: PATCH

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

Updates File fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "name?": "string",
    "size?": "number",
    "type?": "string",
    "enduserId?": "string",
    "hideFromEnduserPortal?": "boolean",
    "pushedToClientPortal?": "boolean",
    "hiddenFromEnduser?": "boolean",
    "isCalledOut?": "boolean"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Delete File

Method: DELETE

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

Delete one File

Authentication info only

FormFields

Load Choices From Database

Method: GET

https://api.tellescope.com/v1/form-fields/load-choices-from-database

Loads choices for a Database Select field type in a form

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

Load Appointment Booking Info

Method: GET

https://api.tellescope.com/v1/form-fields/booking-info

Loads necessary information for rendering an Appointment Booking field

{
  "bookingPageId": "string",
  "enduserFields?": {
    "state": "string"
  }
}

Create FormField

Method: POST

https://api.tellescope.com/v1/form-field

Creates a new FormField

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "formId": "string",
  "title": "string",
  "headerText?": "string",
  "placeholder?": "string",
  "type?": "string",
  "previousFields?": [
    {
      "type": "root",
      "info": {}
    }
  ],
  "flowchartUI?": {
    "x": "number",
    "y": "number"
  },
  "options?": {
    "bookingPageId": "string",
    "tableChoices": [
      {
        "type": "Text",
        "label": "example string",
        "info": { }
      }
    ],
    "choices": [
      "example string"
    ],
    "from": "number",
    "to": "number",
    "other": "boolean",
    "radio": "boolean",
    "pdfAttachment": "string",
    "subFields": [
      {
        "id": "60398b0231a295e64f084fd9"
      }
    ],
    "validFileTypes": [
      "example string"
    ],
    "productIds": [
      "example string"
    ],
    "chargeImmediately": "boolean",
    "signatureUrl": "string",
    "maxLength": "number",
    "minLength": "number",
    "repeat": "boolean",
    "databaseId": "string",
    "databaseLabel": "string",
    "databaseLabels": [
      "example string"
    ],
    "databaseFilter": {
      "databaseLabel": "string",
      "fieldId": "string"
    },
    "useDatePicker": "boolean",
    "sharedIntakeFields": [
      "example string"
    ],
    "disableGoBack": "boolean",
    "disableNext": "boolean",
    "canvasConsentCategory": {
      "code": "string",
      "display": "string",
      "system": "string"
    },
    "customPriceMessage": "string",
    "billingProvider": "string"
  },
  "description?": "string",
  "htmlDescription?": "string",
  "intakeField?": "string",
  "isOptional?": "boolean",
  "fullZIP?": "boolean",
  "isInGroup?": "boolean",
  "sharedWithEnduser?": "boolean",
  "calloutConditions?": [
    {
      "comparison": "Equals",
      "value": "example string"
    }
  ],
  "highlightOnTimeline?": "boolean",
  "prepopulateFromFields?": "boolean",
  "prepopulateFromDatabase?": {
    "databaseId": "string",
    "field": "string",
    "overwrite": "boolean"
  }
}

Create FormFields

Method: POST

https://api.tellescope.com/v1/form-fields

Creates new FormFields

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "formId": "string",
      "title": "string",
      "headerText?": "string",
      "placeholder?": "string",
      "type?": "string",
      "previousFields?": [
        {
          "type": "root",
          "info": {}
        }
      ],
      "flowchartUI?": {
        "x": "number",
        "y": "number"
      },
      "options?": {
        "bookingPageId": "string",
        "tableChoices": [
          {
            "type": "Text",
            "label": "example string",
            "info": { }
          }
        ],
        "choices": [
          "example string"
        ],
        "from": "number",
        "to": "number",
        "other": "boolean",
        "radio": "boolean",
        "pdfAttachment": "string",
        "subFields": [
          {
            "id": "60398b0231a295e64f084fd9"
          }
        ],
        "validFileTypes": [
          "example string"
        ],
        "productIds": [
          "example string"
        ],
        "chargeImmediately": "boolean",
        "signatureUrl": "string",
        "maxLength": "number",
        "minLength": "number",
        "repeat": "boolean",
        "databaseId": "string",
        "databaseLabel": "string",
        "databaseLabels": [
          "example string"
        ],
        "databaseFilter": {
          "databaseLabel": "string",
          "fieldId": "string"
        },
        "useDatePicker": "boolean",
        "sharedIntakeFields": [
          "example string"
        ],
        "disableGoBack": "boolean",
        "disableNext": "boolean",
        "canvasConsentCategory": {
          "code": "string",
          "display": "string",
          "system": "string"
        },
        "customPriceMessage": "string",
        "billingProvider": "string"
      },
      "description?": "string",
      "htmlDescription?": "string",
      "intakeField?": "string",
      "isOptional?": "boolean",
      "fullZIP?": "boolean",
      "isInGroup?": "boolean",
      "sharedWithEnduser?": "boolean",
      "calloutConditions?": [
        {
          "comparison": "Equals",
          "value": "example string"
        }
      ],
      "highlightOnTimeline?": "boolean",
      "prepopulateFromFields?": "boolean",
      "prepopulateFromDatabase?": {
        "databaseId": "string",
        "field": "string",
        "overwrite": "boolean"
      }
    }
  ]
}

Update FormField

Method: PATCH

https://api.tellescope.com/v1/form-field/:id

Updates FormField fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "formId?": "string",
    "title?": "string",
    "headerText?": "string",
    "placeholder?": "string",
    "type?": "string",
    "previousFields?": [
      {
        "type": "root",
        "info": {}
      }
    ],
    "flowchartUI?": {
      "x": "number",
      "y": "number"
    },
    "options?": {
      "bookingPageId": "string",
      "tableChoices": [
        {
          "type": "Text",
          "label": "example string",
          "info": { }
        }
      ],
      "choices": [
        "example string"
      ],
      "from": "number",
      "to": "number",
      "other": "boolean",
      "radio": "boolean",
      "pdfAttachment": "string",
      "subFields": [
        {
          "id": "60398b0231a295e64f084fd9"
        }
      ],
      "validFileTypes": [
        "example string"
      ],
      "productIds": [
        "example string"
      ],
      "chargeImmediately": "boolean",
      "signatureUrl": "string",
      "maxLength": "number",
      "minLength": "number",
      "repeat": "boolean",
      "databaseId": "string",
      "databaseLabel": "string",
      "databaseLabels": [
        "example string"
      ],
      "databaseFilter": {
        "databaseLabel": "string",
        "fieldId": "string"
      },
      "useDatePicker": "boolean",
      "sharedIntakeFields": [
        "example string"
      ],
      "disableGoBack": "boolean",
      "disableNext": "boolean",
      "canvasConsentCategory": {
        "code": "string",
        "display": "string",
        "system": "string"
      },
      "customPriceMessage": "string",
      "billingProvider": "string"
    },
    "description?": "string",
    "htmlDescription?": "string",
    "intakeField?": "string",
    "isOptional?": "boolean",
    "fullZIP?": "boolean",
    "isInGroup?": "boolean",
    "sharedWithEnduser?": "boolean",
    "calloutConditions?": [
      {
        "comparison": "Equals",
        "value": "example string"
      }
    ],
    "highlightOnTimeline?": "boolean",
    "prepopulateFromFields?": "boolean",
    "prepopulateFromDatabase?": {
      "databaseId": "string",
      "field": "string",
      "overwrite": "boolean"
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get FormField

Method: GET

https://api.tellescope.com/v1/form-field/:id

Get an FormField

{
  "filter?": {}
}

Get FormFields

Method: GET

https://api.tellescope.com/v1/form-fields

Get a page of FormFields

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

Delete FormField

Method: DELETE

https://api.tellescope.com/v1/form-field/:id

Delete one FormField

Authentication info only

FormResponses

Generate Session for Public Form (Public)

Method: POST

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

Generates a session for filling out a public form.

{
  "formId": "string",
  "businessId": "string",
  "email?": "string",
  "phone?": "string",
  "fname?": "string",
  "lname?": "string",
  "publicIdentifier?": "string",
  "state?": "string",
  "customTypeId?": "string",
  "skipMatch?": "boolean"
}

Prepare Form Response

Method: POST

https://api.tellescope.com/v1/prepare-form-response

Generates an access code that allows an enduser to submit a form response.

{
  "formId": "string",
  "enduserId": "string",
  "automationStepId?": "string",
  "expireAt?": "Date",
  "sharedVia?": "string",
  "isInternalNote?": "boolean",
  "title?": "string",
  "parentResponseId?": "string",
  "rootResponseId?": "string",
  "carePlanId?": "string",
  "context?": "string"
}

Generate PDF

Method: GET

https://api.tellescope.com/v1/form-responses/generate-pdf

Get a PDF document generated for a given form response

{
  "id": "string"
}

Push to EHR

Method: POST

https://api.tellescope.com/v1/form-responses/push-to-ehr

Pushes to an external EHR (e.g. Healthie)

{
  "id": "string",
  "addedResponses?": [
    {
      "fieldId": "example string",
      "fieldTitle": "example string",
      "fieldDescription": "example string",
      "fieldHtmlDescription": "example string",
      "answer": {
        "type": "Appointment Booking",
        "value": "example string"
      },
      "externalId": "example string",
      "sharedWithEnduser": true,
      "isCalledOut": true,
      "isHighlightedOnTimeline": true,
      "computedValueKey": "example string"
    }
  ]
}

Save Field Response

Method: PATCH

https://api.tellescope.com/v1/save-field-response

With an accessCode, includes the answer to an individual field in a partial form response.

{
  "formResponseId?": "string",
  "accessCode?": "string",
  "response?": {
    "fieldId": "string",
    "fieldTitle": "string",
    "fieldDescription": "string",
    "fieldHtmlDescription": "string",
    "answer": [
      [
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": [
            { "key": "value" }
          ]
        },
        {
          "type": "string",
          "value": {
            "memberId": "string",
            "payerId": "string",
            "payerName": "string",
            "cardFront": "string",
            "cardBack": "string",
            "relationship": "string",
            "coverageId": "string",
            "requestId": "string",
            "eligibility": "string",
            "eligibilityRanAt": "Date",
            "status": "string",
            "relationshipDetails": {
              "fname": "string",
              "lname": "string",
              "gender": "string",
              "dateOfBirth": "string"
            }
          }
        },
        {
          "type": "string",
          "value": [
            {
              "id": "60398b0231a295e64f084fd9"
            }
          ]
        },
        {
          "type": "string",
          "value": {
            "addressLineOne": "string",
            "addressLineTwo": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "zipPlusFour": "string"
          }
        },
        {
          "type": "string",
          "value": [
            [
              {
                "label": "example string",
                "entry": "example string"
              }
            ]
          ]
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": "number"
        },
        {
          "type": "string",
          "value": "number"
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": "Date"
        },
        {
          "type": "string",
          "value": "string"
        },
        {
          "type": "string",
          "value": {
            "name": "string",
            "secureName": "string",
            "type": "string"
          }
        },
        {
          "type": "string",
          "value": [
            {
              "name": "example string",
              "secureName": "example string",
              "type": "example string"
            }
          ]
        },
        {
          "type": "string",
          "value": [
            "example string"
          ]
        },
        {
          "type": "string",
          "value": [
            "example string"
          ]
        },
        {
          "type": "string",
          "value": [
            "example string"
          ]
        },
        {
          "type": "string",
          "value": {
            "fullName": "string",
            "signed": "boolean",
            "pdfAttachment": "string",
            "url": "string",
            "signedPdfSecureName": "string"
          }
        },
        {
          "type": "string",
          "value": [
            {
              "recordId": "60398b0231a295e64f084fd9",
              "databaseId": "60398b0231a295e64f084fd9",
              "text": "example string"
            }
          ]
        },
        {
          "type": "string",
          "value": [
            {
              "displayTerm": "example string",
              "drugName": "example string",
              "drugSynonym": "example string",
              "otherDrug": "example string",
              "NDCs": [
                "example string"
              ],
              "rxNormCode": "example string",
              "reasonForTaking": "example string",
              "dosage": {
                "value": "example string",
                "unit": "example string",
                "quantity": "example string",
                "frequency": "example string"
              }
            }
          ]
        }
      ]
    ],
    "externalId": "string",
    "sharedWithEnduser": "boolean",
    "isCalledOut": "boolean",
    "isHighlightedOnTimeline": "boolean",
    "computedValueKey": "string"
  },
  "responses?": [
    {
      "fieldId": "example string",
      "fieldTitle": "example string",
      "fieldDescription": "example string",
      "fieldHtmlDescription": "example string",
      "answer": {
        "type": "Appointment Booking",
        "value": "example string"
      },
      "externalId": "example string",
      "sharedWithEnduser": true,
      "isCalledOut": true,
      "isHighlightedOnTimeline": true,
      "computedValueKey": "example string"
    }
  ]
}

Submit Form Response

Method: PATCH

https://api.tellescope.com/v1/submit-form-response

With an accessCode, stores responses to a form.

{
  "accessCode": "string",
  "responses": [
    {
      "fieldId": "example string",
      "fieldTitle": "example string",
      "fieldDescription": "example string",
      "fieldHtmlDescription": "example string",
      "answer": {
        "type": "Appointment Booking",
        "value": "example string"
      },
      "externalId": "example string",
      "sharedWithEnduser": true,
      "isCalledOut": true,
      "isHighlightedOnTimeline": true,
      "computedValueKey": "example string"
    }
  ],
  "automationStepId?": "string",
  "customerId?": "string",
  "productIds?": [
    "example string"
  ]
}

Info for Access Code

Method: GET

https://api.tellescope.com/v1/form-info-for-access-code

With an accessCode, retrieves the relevant info for submitting a form

{
  "accessCode": "string"
}

Stripe details for form field

Method: GET

https://api.tellescope.com/v1/form-responses/stripe-details

Gets the relevant information for a Stripe field

{
  "fieldId": "string"
}

Report

Method: ALL

https://api.tellescope.com/v1/form-responses/report

Builds a report

{
  "queries": { "key": [object Object] },
  "formIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "submittedAtRange?": {
    "from": "Date",
    "to": "Date"
  },
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "enduserFilter?": { "key": string },
  "submittedOnly?": "boolean",
  "includeIds?": "boolean"
}

Related Forms Report

Method: ALL

https://api.tellescope.com/v1/form-responses/related-forms-report

Builds a report on related forms (parent-child)

{
  "formIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "submittedAtRange?": {
    "from": "Date",
    "to": "Date"
  },
  "childSubmittedAtRange?": {
    "from": "Date",
    "to": "Date"
  },
  "answers?": [
    "example string"
  ],
  "groupBy?": "string"
}

Get Enduser Statistics

Method: ALL

https://api.tellescope.com/v1/form-responses/enduser-statistics

Get statistics on the number of *unique* endusers who have submitted forms

{
  "formIds?": [
    "example string"
  ],
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "customTypeId?": "string",
  "enduserFields?": [
    {
      "field": "example string",
      "value": "example string"
    }
  ],
  "groupBy?": "string",
  "includeCalendarEventTemplateIds?": [
    "example string"
  ]
}

Get Enduser Statistics By Submitter

Method: ALL

https://api.tellescope.com/v1/form-responses/enduser-statistics-by-submitter

Get statistics on the number of *unique* endusers who have submitted forms, grouped by form submitter ID

{
  "formIds?": [
    "example string"
  ],
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "customTypeId?": "string",
  "enduserFields?": [
    {
      "field": "example string",
      "value": "example string"
    }
  ],
  "includeCalendarEventTemplateIds?": [
    "example string"
  ]
}

Create FormResponse

Method: POST

https://api.tellescope.com/v1/form-response

Creates a new FormResponse

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId?": "string",
  "submissionExpiresAt?": "number",
  "openedAt?": "Date",
  "publicSubmit?": "boolean",
  "submittedBy?": "string",
  "accessCode?": "string",
  "userEmail?": "string",
  "submittedAt?": "Date",
  "formTitle?": "string",
  "responses?": [
    {
      "fieldId": "example string",
      "fieldTitle": "example string",
      "fieldDescription": "example string",
      "fieldHtmlDescription": "example string",
      "answer": {
        "type": "Appointment Booking",
        "value": "example string"
      },
      "externalId": "example string",
      "sharedWithEnduser": true,
      "isCalledOut": true,
      "isHighlightedOnTimeline": true,
      "computedValueKey": "example string"
    }
  ],
  "draftSavedAt?": "Date",
  "hideFromEnduserPortal?": "boolean",
  "sharedVia?": "string",
  "isInternalNote?": "boolean",
  "pinnedAt?": "Date",
  "publicIdentifier?": "string",
  "source?": "string",
  "externalId?": "string",
  "rootResponseId?": "string",
  "parentResponseId?": "string",
  "tags?": [
    "example string"
  ],
  "carePlanId?": "string",
  "context?": "string"
}

Create FormResponses

Method: POST

https://api.tellescope.com/v1/form-responses

Creates new FormResponses

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId?": "string",
      "submissionExpiresAt?": "number",
      "openedAt?": "Date",
      "publicSubmit?": "boolean",
      "submittedBy?": "string",
      "accessCode?": "string",
      "userEmail?": "string",
      "submittedAt?": "Date",
      "formTitle?": "string",
      "responses?": [
        {
          "fieldId": "example string",
          "fieldTitle": "example string",
          "fieldDescription": "example string",
          "fieldHtmlDescription": "example string",
          "answer": {
            "type": "Appointment Booking",
            "value": "example string"
          },
          "externalId": "example string",
          "sharedWithEnduser": true,
          "isCalledOut": true,
          "isHighlightedOnTimeline": true,
          "computedValueKey": "example string"
        }
      ],
      "draftSavedAt?": "Date",
      "hideFromEnduserPortal?": "boolean",
      "sharedVia?": "string",
      "isInternalNote?": "boolean",
      "pinnedAt?": "Date",
      "publicIdentifier?": "string",
      "source?": "string",
      "externalId?": "string",
      "rootResponseId?": "string",
      "parentResponseId?": "string",
      "tags?": [
        "example string"
      ],
      "carePlanId?": "string",
      "context?": "string"
    }
  ]
}

Update FormResponse

Method: PATCH

https://api.tellescope.com/v1/form-response/:id

Updates FormResponse fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "enduserId?": "string",
    "openedAt?": "Date",
    "publicSubmit?": "boolean",
    "submittedBy?": "string",
    "accessCode?": "string",
    "userEmail?": "string",
    "submittedAt?": "Date",
    "formTitle?": "string",
    "responses?": [
      {
        "fieldId": "example string",
        "fieldTitle": "example string",
        "fieldDescription": "example string",
        "fieldHtmlDescription": "example string",
        "answer": {
          "type": "Appointment Booking",
          "value": "example string"
        },
        "externalId": "example string",
        "sharedWithEnduser": true,
        "isCalledOut": true,
        "isHighlightedOnTimeline": true,
        "computedValueKey": "example string"
      }
    ],
    "draftSavedAt?": "Date",
    "hideFromEnduserPortal?": "boolean",
    "sharedVia?": "string",
    "isInternalNote?": "boolean",
    "pinnedAt?": "Date",
    "publicIdentifier?": "string",
    "source?": "string",
    "externalId?": "string",
    "rootResponseId?": "string",
    "parentResponseId?": "string",
    "tags?": [
      "example string"
    ],
    "carePlanId?": "string",
    "context?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get FormResponse

Method: GET

https://api.tellescope.com/v1/form-response/:id

Get an FormResponse

{
  "filter?": {}
}

Get FormResponses

Method: GET

https://api.tellescope.com/v1/form-responses

Get a page of FormResponses

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

Delete FormResponse

Method: DELETE

https://api.tellescope.com/v1/form-response/:id

Delete one FormResponse

Authentication info only

Forms

Get details for public form (Public)

Method: GET

https://api.tellescope.com/v1/forms/public-details

Gets details for public form, e.g. whether to require date of birth

{
  "formId": "string"
}

Form Statistics

Method: GET

https://api.tellescope.com/v1/forms/statistics

Gets response statistics for a given form

{
  "formId": "string",
  "range?": {
    "from": "Date",
    "to": "Date"
  }
}

Create Form

Method: POST

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

Creates a new Form

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "numFields?": "number",
  "displayTitle?": "string",
  "description?": "string",
  "customGreeting?": "string",
  "customSignature?": "string",
  "customSubject?": "string",
  "allowPublicURL?": "boolean",
  "intakePhone?": "string",
  "intakeEmailRequired?": "boolean",
  "intakeEmailHidden?": "boolean",
  "intakeDateOfBirth?": "string",
  "intakeState?": "string",
  "thanksMessage?": "string",
  "htmlThanksMessage?": "string",
  "type?": "string",
  "scoring?": [
    {
      "fieldId": "60398b0231a295e64f084fd9",
      "response": "example string",
      "score": "example string"
    }
  ],
  "productIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "submitRedirectURL?": "string",
  "customization?": {
    "publicFormHTMLDescription": "string",
    "publicFormSubmitHTMLDescription": "string",
    "publicLabelPrefix": "string",
    "hideProgressBar": "boolean",
    "hideLogo": "boolean",
    "showRestartAtEnd": "boolean",
    "multiPagePublicQuestions": "boolean",
    "hideBg": "boolean"
  },
  "publicFormIdRedirect?": "string",
  "disabled?": "boolean",
  "disableAutomaticIntegrationPush?": "boolean",
  "customTypeIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "lockResponsesOnSubmission?": "boolean",
  "tags?": [
    "example string"
  ],
  "language?": "string"
}

Create Forms

Method: POST

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

Creates new Forms

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "numFields?": "number",
      "displayTitle?": "string",
      "description?": "string",
      "customGreeting?": "string",
      "customSignature?": "string",
      "customSubject?": "string",
      "allowPublicURL?": "boolean",
      "intakePhone?": "string",
      "intakeEmailRequired?": "boolean",
      "intakeEmailHidden?": "boolean",
      "intakeDateOfBirth?": "string",
      "intakeState?": "string",
      "thanksMessage?": "string",
      "htmlThanksMessage?": "string",
      "type?": "string",
      "scoring?": [
        {
          "fieldId": "60398b0231a295e64f084fd9",
          "response": "example string",
          "score": "example string"
        }
      ],
      "productIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "submitRedirectURL?": "string",
      "customization?": {
        "publicFormHTMLDescription": "string",
        "publicFormSubmitHTMLDescription": "string",
        "publicLabelPrefix": "string",
        "hideProgressBar": "boolean",
        "hideLogo": "boolean",
        "showRestartAtEnd": "boolean",
        "multiPagePublicQuestions": "boolean",
        "hideBg": "boolean"
      },
      "publicFormIdRedirect?": "string",
      "disabled?": "boolean",
      "disableAutomaticIntegrationPush?": "boolean",
      "customTypeIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "lockResponsesOnSubmission?": "boolean",
      "tags?": [
        "example string"
      ],
      "language?": "string"
    }
  ]
}

Update Form

Method: PATCH

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

Updates Form fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "numFields?": "number",
    "displayTitle?": "string",
    "description?": "string",
    "customGreeting?": "string",
    "customSignature?": "string",
    "customSubject?": "string",
    "allowPublicURL?": "boolean",
    "intakePhone?": "string",
    "intakeEmailRequired?": "boolean",
    "intakeEmailHidden?": "boolean",
    "intakeDateOfBirth?": "string",
    "intakeState?": "string",
    "thanksMessage?": "string",
    "htmlThanksMessage?": "string",
    "type?": "string",
    "scoring?": [
      {
        "fieldId": "60398b0231a295e64f084fd9",
        "response": "example string",
        "score": "example string"
      }
    ],
    "productIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "submitRedirectURL?": "string",
    "customization?": {
      "publicFormHTMLDescription": "string",
      "publicFormSubmitHTMLDescription": "string",
      "publicLabelPrefix": "string",
      "hideProgressBar": "boolean",
      "hideLogo": "boolean",
      "showRestartAtEnd": "boolean",
      "multiPagePublicQuestions": "boolean",
      "hideBg": "boolean"
    },
    "publicFormIdRedirect?": "string",
    "disabled?": "boolean",
    "disableAutomaticIntegrationPush?": "boolean",
    "customTypeIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "lockResponsesOnSubmission?": "boolean",
    "tags?": [
      "example string"
    ],
    "language?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Form

Method: GET

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

Get an Form

{
  "filter?": {}
}

Get Forms

Method: GET

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

Get a page of Forms

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

Delete Form

Method: DELETE

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

Delete one Form

Authentication info only

ForumPosts

Create ForumPost

Method: POST

https://api.tellescope.com/v1/forum-post

Creates a new ForumPost

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "forumId": "string",
  "postedBy?": {
    "type": "string",
    "id": "string"
  },
  "numComments?": "number",
  "numLikes?": "number",
  "title": "string",
  "textContent": "string",
  "htmlContent?": "string",
  "editorState?": "string",
  "slug?": "string",
  "attachments?": [
    {
      "name": "example string",
      "secureName": "example string"
    }
  ]
}

Create ForumPosts

Method: POST

https://api.tellescope.com/v1/forum-posts

Creates new ForumPosts

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "forumId": "string",
      "postedBy?": {
        "type": "string",
        "id": "string"
      },
      "numComments?": "number",
      "numLikes?": "number",
      "title": "string",
      "textContent": "string",
      "htmlContent?": "string",
      "editorState?": "string",
      "slug?": "string",
      "attachments?": [
        {
          "name": "example string",
          "secureName": "example string"
        }
      ]
    }
  ]
}

Update ForumPost

Method: PATCH

https://api.tellescope.com/v1/forum-post/:id

Updates ForumPost fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "forumId?": "string",
    "postedBy?": {
      "type": "string",
      "id": "string"
    },
    "title?": "string",
    "textContent?": "string",
    "htmlContent?": "string",
    "editorState?": "string",
    "slug?": "string",
    "attachments?": [
      {
        "name": "example string",
        "secureName": "example string"
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get ForumPost

Method: GET

https://api.tellescope.com/v1/forum-post/:id

Get an ForumPost

{
  "filter?": {}
}

Get ForumPosts

Method: GET

https://api.tellescope.com/v1/forum-posts

Get a page of ForumPosts

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

Delete ForumPost

Method: DELETE

https://api.tellescope.com/v1/forum-post/:id

Delete one ForumPost

Authentication info only

Forums

Constraints

  • title must be unique across Forums

Create Forum

Method: POST

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

Creates a new Forum

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "description?": "string",
  "publicRead?": "boolean",
  "slug?": "string"
}

Create Forums

Method: POST

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

Creates new Forums

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "description?": "string",
      "publicRead?": "boolean",
      "slug?": "string"
    }
  ]
}

Update Forum

Method: PATCH

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

Updates Forum fields

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

Get Forum

Method: GET

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

Get an Forum

{
  "filter?": {}
}

Get Forums

Method: GET

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

Get a page of Forums

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

Delete Forum

Method: DELETE

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

Delete one Forum

Authentication info only

GroupMmsConversations

Start Conversation

Method: POST

https://api.tellescope.com/v1/group-mms-conversations/start-conversation

Creates a new conversation and sends the initial message

{
  "message": "string",
  "sender": "string",
  "enduserIds": [
    "60398b0231a295e64f084fd9"
  ],
  "userIds": [
    "60398b0231a295e64f084fd9"
  ],
  "phoneNumber": "string",
  "title": "string"
}

Send Message

Method: POST

https://api.tellescope.com/v1/group-mms-conversations/send-message

Sends a new message in an existing conversation

{
  "message": "string",
  "sender": "string",
  "conversationId": "string"
}

Get GroupMmsConversation

Method: GET

https://api.tellescope.com/v1/group-mms-conversation/:id

Get an GroupMmsConversation

{
  "filter?": {}
}

Get GroupMmsConversations

Method: GET

https://api.tellescope.com/v1/group-mms-conversations

Get a page of GroupMmsConversations

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

Update GroupMmsConversation

Method: PATCH

https://api.tellescope.com/v1/group-mms-conversation/:id

Updates GroupMmsConversation fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "userIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "enduserIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "userStates?": [
      {
        "numUnread": 0,
        "id": "example string"
      }
    ],
    "tags?": [
      "example string"
    ],
    "suggestedReply?": "string",
    "hiddenBy?": { string: Date }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Delete GroupMmsConversation

Method: DELETE

https://api.tellescope.com/v1/group-mms-conversation/:id

Delete one GroupMmsConversation

Authentication info only

Integrations

Creates (include clientId, clientSecret) or removes a Zoom configuration (Admin Only)

Method: POST

https://api.tellescope.com/v1/integrations/zoom-configuration

{
  "clientId?": "string",
  "clientSecret?": "string"
}

Generates a link to create a Google integration with Tellescope

Method: POST

https://api.tellescope.com/v1/generate-google-auth-url

Authentication info only

Generates a link to create a Square integration with Tellescope

Method: POST

https://api.tellescope.com/v1/generate-square-auth-url

Authentication info only

Method: POST

https://api.tellescope.com/v1/generate-oauth2-auth-url

{
  "integration?": "string"
}

Disconnects an integration with Square

Method: POST

https://api.tellescope.com/v1/disconnect-oauth2-integration

{
  "integration?": "string"
}

Uses a refresh_token to refresh a session and return the result

Method: POST

https://api.tellescope.com/v1/refresh-oauth2-session

{}

Begin Stripe integration via Connect

Method: POST

https://api.tellescope.com/v1/connect-stripe

{
  "countryCode?": "string"
}

Connect Photon Health

Method: POST

https://api.tellescope.com/v1/integrations/connect-photon

{
  "environment?": "string"
}

Disconnect Photon Health (Admin Only)

Method: POST

https://api.tellescope.com/v1/integrations/disconnect-photon

Authentication info only

Connect Elation

Method: POST

https://api.tellescope.com/v1/integrations/connect-elation

{
  "environment?": "string"
}

Disconnect Elation (Admin Only)

Method: POST

https://api.tellescope.com/v1/integrations/disconnect-elation

Authentication info only

Configure Zendesk (Admin Only)

Method: POST

https://api.tellescope.com/v1/integrations/configure-zendesk

{
  "adminAPIKey": "string",
  "apiKeyEmail": "string",
  "clientId": "string",
  "clientSecret": "string",
  "subdomain": "string"
}

Remove Zendesk Configuration (Admin Only)

Method: POST

https://api.tellescope.com/v1/integrations/remove-zendesk-configuration

Authentication info only

Add an API-Key based integration

Method: POST

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

{
  "API_KEY": "string",
  "integration": "string",
  "environment?": "string",
  "externalId?": "string",
  "webhooksSecret?": "string",
  "fields?": { "key": string }
}

Remove an API-Key based integration

Method: DELETE

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

{
  "integration": "string"
}

Syncs EHR data which is not supported by webhooks (e.g. Dr. Chrono lab results)

Method: POST

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

Authentication info only

Syncs background tasks (like subscribing to Gmail notifications) once per 24hours

Method: POST

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

Authentication info only

Load Payers

Method: GET

https://api.tellescope.com/v1/integrations/load-payers

Loads insurer options for Insurance question type, pulling from integrations like Canvas/Candid

{
  "integration?": "string",
  "offset?": "number",
  "limit?": "number",
  "query?": "string",
  "next_page_token?": "string"
}

Create Integration

Method: POST

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

Creates a new Integration

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "authentication": {
    "type": "string",
    "info": {
      "access_token": "string",
      "refresh_token": "string",
      "scope": "string",
      "expiry_date": "number",
      "token_type": "string",
      "external_id": "string",
      "state": "string",
      "email": "string"
    }
  },
  "lastSync?": "number",
  "emailDisabled?": "boolean",
  "syncUnrecognizedSenders?": "boolean",
  "calendars?": [
    "example string"
  ],
  "webhooksSecret?": "string"
}

Create Integrations

Method: POST

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

Creates new Integrations

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "authentication": {
        "type": "string",
        "info": {
          "access_token": "string",
          "refresh_token": "string",
          "scope": "string",
          "expiry_date": "number",
          "token_type": "string",
          "external_id": "string",
          "state": "string",
          "email": "string"
        }
      },
      "lastSync?": "number",
      "emailDisabled?": "boolean",
      "syncUnrecognizedSenders?": "boolean",
      "calendars?": [
        "example string"
      ],
      "webhooksSecret?": "string"
    }
  ]
}

Update Integration

Method: PATCH

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

Updates Integration fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "authentication?": {
      "type": "string",
      "info": {
        "access_token": "string",
        "refresh_token": "string",
        "scope": "string",
        "expiry_date": "number",
        "token_type": "string",
        "external_id": "string",
        "state": "string",
        "email": "string"
      }
    },
    "lastSync?": "number",
    "emailDisabled?": "boolean",
    "syncUnrecognizedSenders?": "boolean",
    "calendars?": [
      "example string"
    ],
    "webhooksSecret?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Integration

Method: GET

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

Get an Integration

{
  "filter?": {}
}

Get Integrations

Method: GET

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

Get a page of Integrations

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

Delete Integration

Method: DELETE

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

Delete one Integration

Authentication info only

Journeys

Constraints

  • title must be unique across Journeys
  • states.name must be unique for each Journeys
  • states must include defaultState

Delete States

Method: DELETE

https://api.tellescope.com/v1/journey/:id/states

Deletes states in a journey. Endusers and automations are updated automatically.

{
  "states": [
    "example string"
  ]
}

Handle Incoming Communication

Method: POST

https://api.tellescope.com/v1/journeys/handle-incoming-communication

Handles removing endusers from relevant journeys and provides other automation on an incoming communication

{
  "enduserId": "string",
  "channel?": "string",
  "messageId?": "string"
}

Handle Incoming Communication

Method: GET

https://api.tellescope.com/v1/journeys/statistics

Gets statistics for a journey

{
  "journeyId": "string"
}

Create Journey

Method: POST

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

Creates a new Journey

  • To update state names, use Update State to ensure that updates propagate to endusers
{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "states?": [
    {
      "priority": "Disengaged",
      "description": "example string",
      "requiresFollowup": true
    }
  ],
  "onIncomingEnduserCommunication?": "string",
  "tags?": [
    "example string"
  ]
}

Create Journeys

Method: POST

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

Creates new Journeys

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "states?": [
        {
          "priority": "Disengaged",
          "description": "example string",
          "requiresFollowup": true
        }
      ],
      "onIncomingEnduserCommunication?": "string",
      "tags?": [
        "example string"
      ]
    }
  ]
}

Update Journey

Method: PATCH

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

Updates Journey fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "states?": [
      {
        "priority": "Disengaged",
        "description": "example string",
        "requiresFollowup": true
      }
    ],
    "onIncomingEnduserCommunication?": "string",
    "tags?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Journey

Method: GET

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

Get an Journey

{
  "filter?": {}
}

Get Journeys

Method: GET

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

Get a page of Journeys

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

Delete Journey

Method: DELETE

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

Delete one Journey

Authentication info only

ManagedContentRecordAssignments

Constraints

  • All of [contentId, enduserId] must be unique for each ManagedContentRecordAssignments

Create ManagedContentRecordAssignment

Method: POST

https://api.tellescope.com/v1/managed-content-record-assignment

Creates a new ManagedContentRecordAssignment

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

Create ManagedContentRecordAssignments

Method: POST

https://api.tellescope.com/v1/managed-content-record-assignments

Creates new ManagedContentRecordAssignments

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

Update ManagedContentRecordAssignment

Method: PATCH

https://api.tellescope.com/v1/managed-content-record-assignment/:id

Updates ManagedContentRecordAssignment fields

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

Get ManagedContentRecordAssignment

Method: GET

https://api.tellescope.com/v1/managed-content-record-assignment/:id

Get an ManagedContentRecordAssignment

{
  "filter?": {}
}

Get ManagedContentRecordAssignments

Method: GET

https://api.tellescope.com/v1/managed-content-record-assignments

Get a page of ManagedContentRecordAssignments

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

Delete ManagedContentRecordAssignment

Method: DELETE

https://api.tellescope.com/v1/managed-content-record-assignment/:id

Delete one ManagedContentRecordAssignment

Authentication info only

ManagedContentRecords

For accessing content which is available without authentication (Public)

Method: GET

https://api.tellescope.com/v1/managed-content-records/load-unauthenticated

{
  "id": "string"
}

Update Indexes

Method: PATCH

https://api.tellescope.com/v1/managed-content-records/update-indexes

Updates indexes for a number of managed content records to adjust the default sorting

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

Method: POST

https://api.tellescope.com/v1/managed-content-records/generate-embedding

{
  "id": "string"
}

Search content using AI integration

Method: POST

https://api.tellescope.com/v1/managed-content-records/search

{
  "query": "string",
  "type?": "string"
}

Create ManagedContentRecord

Method: POST

https://api.tellescope.com/v1/managed-content-record

Creates a new ManagedContentRecord

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "slug?": "string",
  "description?": "string",
  "textContent": "string",
  "htmlContent?": "string",
  "editorState?": "string",
  "type?": "string",
  "enduserId?": "string",
  "assignmentType?": "string",
  "attachments?": [
    {
      "name": "example string",
      "secureName": "example string"
    }
  ],
  "blocks?": [
    {
      "type": "h1",
      "info": {
        "text": "example string"
      }
    }
  ],
  "headerPhoto?": "string",
  "publicRead?": "boolean",
  "mode?": "string",
  "files?": [
    "example string"
  ],
  "tags?": [
    "example string"
  ],
  "embeddingType?": "string",
  "embedding?": [
    -10000000000000
  ],
  "forInternalUse?": "boolean",
  "allowUnauthenticatedAccess?": "boolean"
}

Create ManagedContentRecords

Method: POST

https://api.tellescope.com/v1/managed-content-records

Creates new ManagedContentRecords

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "slug?": "string",
      "description?": "string",
      "textContent": "string",
      "htmlContent?": "string",
      "editorState?": "string",
      "type?": "string",
      "enduserId?": "string",
      "assignmentType?": "string",
      "attachments?": [
        {
          "name": "example string",
          "secureName": "example string"
        }
      ],
      "blocks?": [
        {
          "type": "h1",
          "info": {
            "text": "example string"
          }
        }
      ],
      "headerPhoto?": "string",
      "publicRead?": "boolean",
      "mode?": "string",
      "files?": [
        "example string"
      ],
      "tags?": [
        "example string"
      ],
      "embeddingType?": "string",
      "embedding?": [
        -10000000000000
      ],
      "forInternalUse?": "boolean",
      "allowUnauthenticatedAccess?": "boolean"
    }
  ]
}

Update ManagedContentRecord

Method: PATCH

https://api.tellescope.com/v1/managed-content-record/:id

Updates ManagedContentRecord fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "slug?": "string",
    "description?": "string",
    "textContent?": "string",
    "htmlContent?": "string",
    "editorState?": "string",
    "enduserId?": "string",
    "assignmentType?": "string",
    "attachments?": [
      {
        "name": "example string",
        "secureName": "example string"
      }
    ],
    "blocks?": [
      {
        "type": "h1",
        "info": {
          "text": "example string"
        }
      }
    ],
    "headerPhoto?": "string",
    "publicRead?": "boolean",
    "mode?": "string",
    "files?": [
      "example string"
    ],
    "tags?": [
      "example string"
    ],
    "embeddingType?": "string",
    "embedding?": [
      -10000000000000
    ],
    "forInternalUse?": "boolean",
    "allowUnauthenticatedAccess?": "boolean"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get ManagedContentRecord

Method: GET

https://api.tellescope.com/v1/managed-content-record/:id

Get an ManagedContentRecord

{
  "filter?": {}
}

Get ManagedContentRecords

Method: GET

https://api.tellescope.com/v1/managed-content-records

Get a page of ManagedContentRecords

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

Delete ManagedContentRecord

Method: DELETE

https://api.tellescope.com/v1/managed-content-record/:id

Delete one ManagedContentRecord

Authentication info only

Meetings

Get Meeting

Method: GET

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

Get a meeting

{
  "id?": "string"
}

Start Meeting

Method: POST

https://api.tellescope.com/v1/start-meeting

Generates an video meeting room

{
  "attendees?": [
    {
      "type": "user",
      "id": "60398b0231a295e64f084fd9"
    }
  ],
  "publicRead?": "boolean"
}

Send Meeting Invite

Method: POST

https://api.tellescope.com/v1/send-meeting-invite

Sends a meeting invite via email to the given enduser

{
  "meetingId": "string",
  "enduserId": "string"
}

End Meeting

Method: POST

https://api.tellescope.com/v1/end-meeting

Ends a video meeting

{
  "id": "string"
}

Add Attendees to Meeting

Method: POST

https://api.tellescope.com/v1/add-attendees-to-meeting

Adds other attendees to a meeting

{
  "id": "string",
  "attendees": [
    {
      "type": "user",
      "id": "60398b0231a295e64f084fd9"
    }
  ]
}

Get attendee info for meeting

Method: GET

https://api.tellescope.com/v1/attendee-info

Gets meeting info for the current user, and details about other attendees

{
  "id": "string"
}

Get list of meetings

Method: GET

https://api.tellescope.com/v1/my-meetings

Gets meetings for the current user.

Authentication info only

Start Scheduled Meeting

Method: POST

https://api.tellescope.com/v1/start-meeting-for-event

Generates an video meeting room

{
  "calendarEventId": "string"
}

Join Scheduled Meeting

Method: POST

https://api.tellescope.com/v1/join-meeting-for-event

Generates an video meeting room

{
  "calendarEventId": "string"
}

Get Meetings (Admin Only)

Method: GET

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

Get a page of Meetings

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

Notes

Create Note

Method: POST

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

Creates a new Note

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "ticketId?": "string",
  "text?": "string",
  "title?": "string",
  "fields?": {},
  "pinnedAt?": "Date",
  "tags?": [
    "example string"
  ]
}

Create Notes

Method: POST

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

Creates new Notes

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "ticketId?": "string",
      "text?": "string",
      "title?": "string",
      "fields?": {},
      "pinnedAt?": "Date",
      "tags?": [
        "example string"
      ]
    }
  ]
}

Update Note

Method: PATCH

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

Updates Note fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "enduserId?": "string",
    "ticketId?": "string",
    "text?": "string",
    "title?": "string",
    "fields?": {},
    "pinnedAt?": "Date",
    "tags?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Note

Method: GET

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

Get an Note

{
  "filter?": {}
}

Get Notes

Method: GET

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

Get a page of Notes

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

Delete Note

Method: DELETE

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

Delete one Note

Authentication info only

Organizations

Constraints

  • Only organization owner can update owner

Get Organization Theme (Public)

Method: GET

https://api.tellescope.com/v1/organization-theme

Gets theme information for an organization

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

Create Sub Organization (Admin Only)

Method: POST

https://api.tellescope.com/v1/sub-organization

Creates a sub organization

{
  "name": "string",
  "subdomain": "string"
}

Create and Join Organization (Admin Only)

Method: POST

https://api.tellescope.com/v1/organizations/create-and-join

Creates and joins a new organization

{
  "name": "string",
  "subdomain": "string"
}

Get Organization

Method: GET

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

Get an Organization

{
  "filter?": {}
}

Get Organizations

Method: GET

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

Get a page of Organizations

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

Update Organization

Method: PATCH

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

Updates Organization fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "subdomain?": "string",
    "owner?": "string",
    "parentOrganizationId?": "string",
    "subscriptionExpiresAt?": "Date",
    "subscriptionPeriod?": "number",
    "logoVersion?": "number",
    "faviconVersion?": "number",
    "roles?": [
      "example string"
    ],
    "skills?": [
      "example string"
    ],
    "customPortalURL?": "string",
    "portalSettings?": {
      "authentication": {
        "landingTitle": "string",
        "landingGraphic": "string",
        "landingLogo": "string",
        "loginDescription": "string",
        "loginGraphic": "string",
        "loginTitle": "string",
        "registerDescription": "string",
        "registerGraphic": "string",
        "registerTitle": "string",
        "hideRegister": "boolean",
        "dontPromptSetPassword": "boolean"
      },
      "communication": {
        "allowEnduserInitiatedChat": "boolean",
        "sendEmailNotificationsToEnduser": "boolean",
        "enduserInitiatedChatDefaultSubject": "string"
      }
    },
    "settings?": {
      "endusers": {
        "disableMultipleChatRooms": "boolean",
        "disableCalendarEventAutoAssignment": "boolean",
        "disableAdhocFields": "boolean",
        "autoReplyEnabled": "boolean",
        "recordCalls": "boolean",
        "transcribeCalls": "boolean",
        "showFreeNote": "boolean",
        "customFields": [
          {
            "type": "Select",
            "info": {
              "options": [
                "example string"
              ],
              "other": true
            },
            "field": "example string",
            "required": true,
            "hiddenFromProfile": true
          }
        ],
        "builtinFields": [
          {
            "hidden": true,
            "required": true,
            "requireConfirmation": true
          }
        ],
        "tags": [
          "example string"
        ],
        "transcribeCallInboundPlayback": "string",
        "sendSMSOnZoomStart": "boolean",
        "enableGroupMMS": "boolean",
        "enableAccessTags": "boolean",
        "flaggedFileText": "string",
        "defaultPhoneNumber": "string",
        "showBulkFormInput": "boolean"
      },
      "tickets": {
        "defaultJourneyDueDateOffsetInMS": "number",
        "disableSnooze": "boolean",
        "showCommunications": "boolean"
      },
      "calendar": {
        "dayStart": {
          "hour": "number",
          "minute": "number"
        },
        "dayEnd": {
          "hour": "number",
          "minute": "number"
        },
        "bookingStartOffset": {
          "month": "number",
          "day": "number",
          "hour": "number"
        },
        "bookingEndOffset": {
          "month": "number",
          "day": "number",
          "hour": "number"
        },
        "templateRequired": "boolean",
        "locationRequired": "boolean"
      },
      "dashboard": {
        "view": {
          "blocks": [
            {
              "type": "Inbox"
            }
          ]
        }
      }
    },
    "timezone?": "string",
    "forwardAllIncomingEmailsTo?": "string",
    "zendeskSettings?": {
      "priorityGroups": [
        "example string"
      ],
      "resolutionFieldId": "string",
      "resolutionFieldOptions": [
        "example string"
      ]
    },
    "hasTicketQueues?": "boolean",
    "customAutoreplyMessage?": "string",
    "altVitalTeamIds?": [
      {}
    ],
    "billingOrganizationName?": "string",
    "billingOrganizationNPI?": "string",
    "billingOrganizationTaxId?": "string",
    "billingOrganizationAddress?": {
      "city": "string",
      "state": "string",
      "lineOne": "string",
      "lineTwo": "string",
      "zipPlusFour": "string"
    },
    "videoCallBackgroundImage?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Delete Organization

Method: DELETE

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

Delete one Organization

Authentication info only

PhoneCalls

{ "isVoicemail": true } indicates that an inbound call was not answered, but not necessarily that a full voicemail was left
If a voicemail is left, it is indicated by recordingURI, transcription, or recordingDurationInSeconds

Start Phone Call

Method: POST

https://api.tellescope.com/v1/authenticate-twilio-phone-call

Generates an access token for creating / receiving calls via Twilio

{
  "os?": "string",
  "type?": "string"
}

Report

Method: GET

https://api.tellescope.com/v1/phone-calls/report

Builds a report

{
  "queries": { "key": [object Object] },
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "enduserFilter?": { "key": string }
}

Upgrade to Conference

Method: POST

https://api.tellescope.com/v1/phone-calls/upgrade-to-conference

Upgrades a live inbound call to a conference call

{}

Upgrade to Conference

Method: POST

https://api.tellescope.com/v1/phone-calls/add-conference-attendees

Upgrades a live inbound call to a conference call

{
  "enduserId?": "string",
  "byClientId?": [
    "example string"
  ],
  "byPhone?": [
    "example string"
  ]
}

End Conference

Method: POST

https://api.tellescope.com/v1/phone-calls/end-conference

Ends an active conference call for all participants

{}

Create PhoneCall

Method: POST

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

Creates a new PhoneCall

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "transcription?": "string",
  "note?": "string",
  "unread?": "boolean",
  "userId?": "string",
  "pinnedAt?": "Date",
  "readBy?": { string: Date },
  "hiddenBy?": { string: Date },
  "ticketIds?": [
    "example string"
  ],
  "tags?": [
    "example string"
  ]
}

Create PhoneCalls

Method: POST

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

Creates new PhoneCalls

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "transcription?": "string",
      "note?": "string",
      "unread?": "boolean",
      "userId?": "string",
      "pinnedAt?": "Date",
      "readBy?": { string: Date },
      "hiddenBy?": { string: Date },
      "ticketIds?": [
        "example string"
      ],
      "tags?": [
        "example string"
      ]
    }
  ]
}

Update PhoneCall

Method: PATCH

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

Updates PhoneCall fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "enduserId?": "string",
    "transcription?": "string",
    "note?": "string",
    "unread?": "boolean",
    "userId?": "string",
    "pinnedAt?": "Date",
    "readBy?": { string: Date },
    "hiddenBy?": { string: Date },
    "ticketIds?": [
      "example string"
    ],
    "tags?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get PhoneCall

Method: GET

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

Get an PhoneCall

{
  "filter?": {}
}

Get PhoneCalls

Method: GET

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

Get a page of PhoneCalls

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

Delete PhoneCall

Method: DELETE

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

Delete one PhoneCall

Authentication info only

PhoneTrees

Create PhoneTree

Method: POST

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

Creates a new PhoneTree

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "number": "string",
  "isActive": "boolean",
  "nodes": [
    {
      "action": {
        "type": "Gather",
        "info": {
          "playback": {
            "type": "Play",
            "info": {
              "url": "example string",
              "script": "example string"
            }
          },
          "digits": true,
          "speech": true
        }
      },
      "events": [
        {
          "type": "Start",
          "info": { },
          "parentId": "example string"
        }
      ],
      "flowchartUI": {
        "x": -10000000000000,
        "y": -10000000000000
      }
    }
  ],
  "testEnduserIds?": [
    "example string"
  ],
  "enduserCondition?": "string"
}

Create PhoneTrees

Method: POST

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

Creates new PhoneTrees

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "number": "string",
      "isActive": "boolean",
      "nodes": [
        {
          "action": {
            "type": "Gather",
            "info": {
              "playback": {
                "type": "Play",
                "info": {
                  "url": "example string",
                  "script": "example string"
                }
              },
              "digits": true,
              "speech": true
            }
          },
          "events": [
            {
              "type": "Start",
              "info": { },
              "parentId": "example string"
            }
          ],
          "flowchartUI": {
            "x": -10000000000000,
            "y": -10000000000000
          }
        }
      ],
      "testEnduserIds?": [
        "example string"
      ],
      "enduserCondition?": "string"
    }
  ]
}

Update PhoneTree

Method: PATCH

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

Updates PhoneTree fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "number?": "string",
    "isActive?": "boolean",
    "nodes?": [
      {
        "action": {
          "type": "Gather",
          "info": {
            "playback": {
              "type": "Play",
              "info": {
                "url": "example string",
                "script": "example string"
              }
            },
            "digits": true,
            "speech": true
          }
        },
        "events": [
          {
            "type": "Start",
            "info": { },
            "parentId": "example string"
          }
        ],
        "flowchartUI": {
          "x": -10000000000000,
          "y": -10000000000000
        }
      }
    ],
    "testEnduserIds?": [
      "example string"
    ],
    "enduserCondition?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get PhoneTree

Method: GET

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

Get an PhoneTree

{
  "filter?": {}
}

Get PhoneTrees

Method: GET

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

Get a page of PhoneTrees

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

Delete PhoneTree

Method: DELETE

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

Delete one PhoneTree

Authentication info only

PortalCustomizations

Constraints

  • page must be unique across PortalCustomizations
  • Home page cannot be disabled

Create PortalCustomization

Method: POST

https://api.tellescope.com/v1/portal-customization

Creates a new PortalCustomization

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title?": "string",
  "page": "string",
  "blocks": [
    {
      "type": "carePlan",
      "info": {}
    }
  ],
  "disabled?": "boolean",
  "mobileBottomNavigationPosition?": "number",
  "headerImageURL?": "string"
}

Create PortalCustomizations

Method: POST

https://api.tellescope.com/v1/portal-customizations

Creates new PortalCustomizations

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title?": "string",
      "page": "string",
      "blocks": [
        {
          "type": "carePlan",
          "info": {}
        }
      ],
      "disabled?": "boolean",
      "mobileBottomNavigationPosition?": "number",
      "headerImageURL?": "string"
    }
  ]
}

Update PortalCustomization

Method: PATCH

https://api.tellescope.com/v1/portal-customization/:id

Updates PortalCustomization fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "page?": "string",
    "blocks?": [
      {
        "type": "carePlan",
        "info": {}
      }
    ],
    "disabled?": "boolean",
    "mobileBottomNavigationPosition?": "number",
    "headerImageURL?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get PortalCustomization

Method: GET

https://api.tellescope.com/v1/portal-customization/:id

Get an PortalCustomization

{
  "filter?": {}
}

Get PortalCustomizations

Method: GET

https://api.tellescope.com/v1/portal-customizations

Get a page of PortalCustomizations

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

Delete PortalCustomization

Method: DELETE

https://api.tellescope.com/v1/portal-customization/:id

Delete one PortalCustomization

Authentication info only

PostComments

Create PostComment

Method: POST

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

Creates a new PostComment

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "forumId": "string",
  "postId": "string",
  "threadId?": "string",
  "replyTo?": "string",
  "postedBy?": {
    "type": "string",
    "id": "string"
  },
  "attachments?": [
    "example string"
  ],
  "textContent": "string",
  "htmlContent?": "string",
  "editorState?": "string",
  "numLikes?": "number",
  "numReplies?": "number"
}

Create PostComments

Method: POST

https://api.tellescope.com/v1/post-comments

Creates new PostComments

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "forumId": "string",
      "postId": "string",
      "threadId?": "string",
      "replyTo?": "string",
      "postedBy?": {
        "type": "string",
        "id": "string"
      },
      "attachments?": [
        "example string"
      ],
      "textContent": "string",
      "htmlContent?": "string",
      "editorState?": "string",
      "numLikes?": "number",
      "numReplies?": "number"
    }
  ]
}

Update PostComment

Method: PATCH

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

Updates PostComment fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "forumId?": "string",
    "postId?": "string",
    "threadId?": "string",
    "replyTo?": "string",
    "postedBy?": {
      "type": "string",
      "id": "string"
    },
    "attachments?": [
      "example string"
    ],
    "textContent?": "string",
    "htmlContent?": "string",
    "editorState?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get PostComment

Method: GET

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

Get an PostComment

{
  "filter?": {}
}

Get PostComments

Method: GET

https://api.tellescope.com/v1/post-comments

Get a page of PostComments

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

Delete PostComment

Method: DELETE

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

Delete one PostComment

Authentication info only

PostLikes

Like Forum Post

Method: POST

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

Likes a post

{
  "postId": "string",
  "forumId": "string"
}

Unlike Forum Post

Method: POST

https://api.tellescope.com/v1/unlike-forum-post

Removes a like for a given forum post

{
  "postId": "string",
  "forumId": "string"
}

Get PostLike

Method: GET

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

Get an PostLike

{
  "filter?": {}
}

Get PostLikes

Method: GET

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

Get a page of PostLikes

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

Delete PostLike

Method: DELETE

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

Delete one PostLike

Authentication info only

Products

Constraints

  • title must be unique across Products

Prepare Stripe Checkout

Method: POST

https://api.tellescope.com/v1/products/prepare-stripe-checkout

Prepares a Stripe checkout process

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

Get Stripe Portal Session (Enduser Only)

Method: GET

https://api.tellescope.com/v1/products/stripe-portal-session

Prepares a Stripe checkout process

{
  "return_url": "string"
}

Create Product

Method: POST

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

Creates a new Product

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "cost": {
    "amount": "number",
    "currency": "string"
  },
  "processor?": "string",
  "description?": "string",
  "htmlDescription?": "string",
  "cptCode?": {
    "code": "number",
    "label": "string"
  },
  "image?": "string",
  "showInPortal?": "boolean",
  "categories?": [
    "example string"
  ],
  "maxCheckoutCount?": "number"
}

Create Products

Method: POST

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

Creates new Products

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "cost": {
        "amount": "number",
        "currency": "string"
      },
      "processor?": "string",
      "description?": "string",
      "htmlDescription?": "string",
      "cptCode?": {
        "code": "number",
        "label": "string"
      },
      "image?": "string",
      "showInPortal?": "boolean",
      "categories?": [
        "example string"
      ],
      "maxCheckoutCount?": "number"
    }
  ]
}

Update Product

Method: PATCH

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

Updates Product fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "cost?": {
      "amount": "number",
      "currency": "string"
    },
    "processor?": "string",
    "description?": "string",
    "htmlDescription?": "string",
    "cptCode?": {
      "code": "number",
      "label": "string"
    },
    "image?": "string",
    "showInPortal?": "boolean",
    "categories?": [
      "example string"
    ],
    "maxCheckoutCount?": "number"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Product

Method: GET

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

Get an Product

{
  "filter?": {}
}

Get Products

Method: GET

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

Get a page of Products

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

Delete Product

Method: DELETE

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

Delete one Product

Authentication info only

PurchaseCredits

Create PurchaseCredit

Method: POST

https://api.tellescope.com/v1/purchase-credit

Creates a new PurchaseCredit

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "value": [
    [
      {
        "type": "string",
        "info": {
          "amount": "number",
          "currency": "string"
        }
      }
    ]
  ],
  "usedAt?": "Date",
  "description?": "string"
}

Create PurchaseCredits

Method: POST

https://api.tellescope.com/v1/purchase-credits

Creates new PurchaseCredits

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "value": [
        [
          {
            "type": "string",
            "info": {
              "amount": "number",
              "currency": "string"
            }
          }
        ]
      ],
      "usedAt?": "Date",
      "description?": "string"
    }
  ]
}

Update PurchaseCredit

Method: PATCH

https://api.tellescope.com/v1/purchase-credit/:id

Updates PurchaseCredit fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "enduserId?": "string",
    "value?": [
      [
        {
          "type": "string",
          "info": {
            "amount": "number",
            "currency": "string"
          }
        }
      ]
    ],
    "usedAt?": "Date",
    "description?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get PurchaseCredit

Method: GET

https://api.tellescope.com/v1/purchase-credit/:id

Get an PurchaseCredit

{
  "filter?": {}
}

Get PurchaseCredits

Method: GET

https://api.tellescope.com/v1/purchase-credits

Get a page of PurchaseCredits

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

Delete PurchaseCredit

Method: DELETE

https://api.tellescope.com/v1/purchase-credit/:id

Delete one PurchaseCredit

Authentication info only

Purchases

Create Purchase

Method: POST

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

Creates a new Purchase

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "productId?": "string",
  "productIds?": [
    "example string"
  ],
  "enduserId": "string",
  "cost": {
    "amount": "number",
    "currency": "string"
  },
  "processor": "string",
  "processedAt?": "Date",
  "description?": "string",
  "refundedAmount?": "number",
  "source?": "string",
  "externalId?": "string",
  "cptCode?": {
    "code": "number",
    "label": "string"
  },
  "notes?": "string"
}

Create Purchases

Method: POST

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

Creates new Purchases

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "productId?": "string",
      "productIds?": [
        "example string"
      ],
      "enduserId": "string",
      "cost": {
        "amount": "number",
        "currency": "string"
      },
      "processor": "string",
      "processedAt?": "Date",
      "description?": "string",
      "refundedAmount?": "number",
      "source?": "string",
      "externalId?": "string",
      "cptCode?": {
        "code": "number",
        "label": "string"
      },
      "notes?": "string"
    }
  ]
}

Update Purchase

Method: PATCH

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

Updates Purchase fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "productId?": "string",
    "productIds?": [
      "example string"
    ],
    "enduserId?": "string",
    "cost?": {
      "amount": "number",
      "currency": "string"
    },
    "processor?": "string",
    "processedAt?": "Date",
    "description?": "string",
    "refundedAmount?": "number",
    "source?": "string",
    "externalId?": "string",
    "cptCode?": {
      "code": "number",
      "label": "string"
    },
    "notes?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Purchase

Method: GET

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

Get an Purchase

{
  "filter?": {}
}

Get Purchases

Method: GET

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

Get a page of Purchases

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

Delete Purchase

Method: DELETE

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

Delete one Purchase

Authentication info only

ReferralProviders

Create ReferralProvider

Method: POST

https://api.tellescope.com/v1/referral-provider

Creates a new ReferralProvider

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "fname?": "string",
  "lname?": "string",
  "organizationName": "string",
  "clinicName?": "string",
  "types?": [
    "example string"
  ],
  "acceptedInsurance?": [
    {}
  ],
  "address?": {
    "city": "string",
    "state": "string",
    "lineOne": "string",
    "lineTwo": "string",
    "zipCode": "string",
    "zipPlusFour": "string"
  },
  "email?": "string",
  "phone?": "string",
  "notes?": "string",
  "website?": "string",
  "bookingLink?": "string",
  "uninsuredDescription?": "string",
  "description?": "string",
  "services?": [
    "example string"
  ],
  "locations?": [
    "example string"
  ],
  "languages?": [
    "example string"
  ],
  "eligibilityCriteria?": [
    "example string"
  ]
}

Create ReferralProviders

Method: POST

https://api.tellescope.com/v1/referral-providers

Creates new ReferralProviders

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "fname?": "string",
      "lname?": "string",
      "organizationName": "string",
      "clinicName?": "string",
      "types?": [
        "example string"
      ],
      "acceptedInsurance?": [
        {}
      ],
      "address?": {
        "city": "string",
        "state": "string",
        "lineOne": "string",
        "lineTwo": "string",
        "zipCode": "string",
        "zipPlusFour": "string"
      },
      "email?": "string",
      "phone?": "string",
      "notes?": "string",
      "website?": "string",
      "bookingLink?": "string",
      "uninsuredDescription?": "string",
      "description?": "string",
      "services?": [
        "example string"
      ],
      "locations?": [
        "example string"
      ],
      "languages?": [
        "example string"
      ],
      "eligibilityCriteria?": [
        "example string"
      ]
    }
  ]
}

Update ReferralProvider

Method: PATCH

https://api.tellescope.com/v1/referral-provider/:id

Updates ReferralProvider fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "fname?": "string",
    "lname?": "string",
    "organizationName?": "string",
    "clinicName?": "string",
    "types?": [
      "example string"
    ],
    "acceptedInsurance?": [
      {}
    ],
    "address?": {
      "city": "string",
      "state": "string",
      "lineOne": "string",
      "lineTwo": "string",
      "zipCode": "string",
      "zipPlusFour": "string"
    },
    "email?": "string",
    "phone?": "string",
    "notes?": "string",
    "website?": "string",
    "bookingLink?": "string",
    "uninsuredDescription?": "string",
    "description?": "string",
    "services?": [
      "example string"
    ],
    "locations?": [
      "example string"
    ],
    "languages?": [
      "example string"
    ],
    "eligibilityCriteria?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get ReferralProvider

Method: GET

https://api.tellescope.com/v1/referral-provider/:id

Get an ReferralProvider

{
  "filter?": {}
}

Get ReferralProviders

Method: GET

https://api.tellescope.com/v1/referral-providers

Get a page of ReferralProviders

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

Delete ReferralProvider

Method: DELETE

https://api.tellescope.com/v1/referral-provider/:id

Delete one ReferralProvider

Authentication info only

RoleBasedAccessPermissions

Constraints

  • role must be unique across RoleBasedAccessPermissions
  • role can't be 'Admin'

Get RoleBasedAccessPermission

Method: GET

https://api.tellescope.com/v1/role-based-access-permission/:id

Get an RoleBasedAccessPermission

{
  "filter?": {}
}

Get RoleBasedAccessPermissions

Method: GET

https://api.tellescope.com/v1/role-based-access-permissions

Get a page of RoleBasedAccessPermissions

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

Create RoleBasedAccessPermission

Method: POST

https://api.tellescope.com/v1/role-based-access-permission

Creates a new RoleBasedAccessPermission

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "role": "string",
  "permissions": {
    "enduser_custom_types": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "superbill_providers": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "superbills": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "availability_blocks": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "analytics_frames": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "endusers": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_status_updates": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "engagement_events": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "journeys": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "api_keys": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "emails": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "sms_messages": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "chat_rooms": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "chats": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "users": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "templates": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "files": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "tickets": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "meetings": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "notes": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "forms": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "form_fields": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "form_responses": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "calendar_events": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "calendar_event_templates": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "calendar_event_RSVPs": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "automation_steps": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "automated_actions": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "webhooks": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "user_logs": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "user_notifications": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_observations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "managed_content_records": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "managed_content_record_assignments": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "forums": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "forum_posts": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "post_likes": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "comment_likes": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "post_comments": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "organizations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "integrations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "databases": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "database_records": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "portal_customizations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "care_plans": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_tasks": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "role_based_access_permissions": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "appointment_booking_pages": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "appointment_locations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "products": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "purchase_credits": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "purchases": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "phone_calls": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "background_errors": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_views": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "automation_triggers": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_profile_views": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "referral_providers": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_medications": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "phone_trees": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "table_views": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "email_sync_denials": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "ticket_thread_comments": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "ticket_threads": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "configurations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "ticket_queues": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "group_mms_conversations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_orders": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_encounters": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "apiKeys": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    }
  },
  "uiRestrictions?": {
    "hideDashboard": "boolean",
    "hideInbox": "boolean",
    "hideTeamChat": "boolean",
    "hideEnduserChat": "boolean",
    "disableTicketDueDate": "boolean",
    "disableUnstructuredNotes": "boolean",
    "hideCareplan": "boolean",
    "hiddenFields": [
      {
        "field": "example string",
        "type": "60398b0231a295e64f084fd9"
      }
    ],
    "disabledFields": [
      {
        "field": "example string",
        "type": "60398b0231a295e64f084fd9"
      }
    ]
  }
}

Create RoleBasedAccessPermissions

Method: POST

https://api.tellescope.com/v1/role-based-access-permissions

Creates new RoleBasedAccessPermissions

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "role": "string",
      "permissions": {
        "enduser_custom_types": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "superbill_providers": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "superbills": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "availability_blocks": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "analytics_frames": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "endusers": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_status_updates": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "engagement_events": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "journeys": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "api_keys": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "emails": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "sms_messages": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "chat_rooms": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "chats": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "users": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "templates": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "files": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "tickets": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "meetings": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "notes": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "forms": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "form_fields": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "form_responses": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "calendar_events": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "calendar_event_templates": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "calendar_event_RSVPs": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "automation_steps": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "automated_actions": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "webhooks": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "user_logs": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "user_notifications": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_observations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "managed_content_records": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "managed_content_record_assignments": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "forums": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "forum_posts": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "post_likes": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "comment_likes": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "post_comments": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "organizations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "integrations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "databases": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "database_records": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "portal_customizations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "care_plans": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_tasks": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "role_based_access_permissions": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "appointment_booking_pages": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "appointment_locations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "products": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "purchase_credits": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "purchases": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "phone_calls": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "background_errors": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_views": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "automation_triggers": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_profile_views": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "referral_providers": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_medications": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "phone_trees": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "table_views": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "email_sync_denials": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "ticket_thread_comments": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "ticket_threads": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "configurations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "ticket_queues": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "group_mms_conversations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_orders": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_encounters": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "apiKeys": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        }
      },
      "uiRestrictions?": {
        "hideDashboard": "boolean",
        "hideInbox": "boolean",
        "hideTeamChat": "boolean",
        "hideEnduserChat": "boolean",
        "disableTicketDueDate": "boolean",
        "disableUnstructuredNotes": "boolean",
        "hideCareplan": "boolean",
        "hiddenFields": [
          {
            "field": "example string",
            "type": "60398b0231a295e64f084fd9"
          }
        ],
        "disabledFields": [
          {
            "field": "example string",
            "type": "60398b0231a295e64f084fd9"
          }
        ]
      }
    }
  ]
}

Update RoleBasedAccessPermission

Method: PATCH

https://api.tellescope.com/v1/role-based-access-permission/:id

Updates RoleBasedAccessPermission fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "role?": "string",
    "permissions?": {
      "enduser_custom_types": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "superbill_providers": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "superbills": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "availability_blocks": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "analytics_frames": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "endusers": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_status_updates": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "engagement_events": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "journeys": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "api_keys": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "emails": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "sms_messages": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "chat_rooms": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "chats": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "users": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "templates": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "files": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "tickets": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "meetings": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "notes": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "forms": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "form_fields": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "form_responses": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "calendar_events": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "calendar_event_templates": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "calendar_event_RSVPs": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "automation_steps": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "automated_actions": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "webhooks": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "user_logs": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "user_notifications": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_observations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "managed_content_records": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "managed_content_record_assignments": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "forums": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "forum_posts": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "post_likes": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "comment_likes": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "post_comments": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "organizations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "integrations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "databases": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "database_records": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "portal_customizations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "care_plans": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_tasks": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "role_based_access_permissions": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "appointment_booking_pages": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "appointment_locations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "products": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "purchase_credits": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "purchases": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "phone_calls": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "background_errors": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_views": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "automation_triggers": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_profile_views": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "referral_providers": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_medications": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "phone_trees": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "table_views": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "email_sync_denials": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "ticket_thread_comments": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "ticket_threads": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "configurations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "ticket_queues": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "group_mms_conversations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_orders": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_encounters": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "apiKeys": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      }
    },
    "uiRestrictions?": {
      "hideDashboard": "boolean",
      "hideInbox": "boolean",
      "hideTeamChat": "boolean",
      "hideEnduserChat": "boolean",
      "disableTicketDueDate": "boolean",
      "disableUnstructuredNotes": "boolean",
      "hideCareplan": "boolean",
      "hiddenFields": [
        {
          "field": "example string",
          "type": "60398b0231a295e64f084fd9"
        }
      ],
      "disabledFields": [
        {
          "field": "example string",
          "type": "60398b0231a295e64f084fd9"
        }
      ]
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Delete RoleBasedAccessPermission

Method: DELETE

https://api.tellescope.com/v1/role-based-access-permission/:id

Delete one RoleBasedAccessPermission

Authentication info only

SmsMessages

Constraints

  • Message must be non-empty
  • Phone number and phone consent must be set for enduser

Leave Message (Public)

Method: POST

https://api.tellescope.com/v1/sms-messages/leave-message

Leaves an SMS message submitted from a website page

{
  "businessId": "string",
  "fname": "string",
  "lname": "string",
  "phone": "string",
  "message": "string"
}

Send Message to Number

Method: POST

https://api.tellescope.com/v1/sms-messages/send-message-to-number

Sends an SMS to the provided phone number, upserting an enduser if no match by phone

  • message must be under 1200 characters
{
  "message": "string",
  "to": "string"
}

Create SmsMessage

Method: POST

https://api.tellescope.com/v1/sms-message

Sends or logs an SMS message

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "logOnly?": "boolean",
  "message": "string",
  "enduserId": "string",
  "userId?": "string",
  "inbound?": "boolean",
  "newThread?": "boolean",
  "readBy?": { string: Date },
  "hiddenBy?": { string: Date },
  "templateId?": "string",
  "automationStepId?": "string",
  "linkOpenTrackingIds?": [
    "example string"
  ],
  "journeyContext?": {
    "calendarEventId": "string",
    "formResponseId": "string",
    "purchaseId": "string"
  },
  "sendAt?": "Date",
  "pinnedAt?": "Date",
  "isDraft?": "boolean",
  "timestamp?": "Date",
  "ticketIds?": [
    "example string"
  ],
  "suggestedReply?": "string",
  "phoneNumber?": "string",
  "enduserPhoneNumber?": "string",
  "tags?": [
    "example string"
  ],
  "batchId?": "string"
}

Create SmsMessages

Method: POST

https://api.tellescope.com/v1/sms-messages

Sends or logs multiple SMS message

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "logOnly?": "boolean",
      "message": "string",
      "enduserId": "string",
      "userId?": "string",
      "inbound?": "boolean",
      "newThread?": "boolean",
      "readBy?": { string: Date },
      "hiddenBy?": { string: Date },
      "templateId?": "string",
      "automationStepId?": "string",
      "linkOpenTrackingIds?": [
        "example string"
      ],
      "journeyContext?": {
        "calendarEventId": "string",
        "formResponseId": "string",
        "purchaseId": "string"
      },
      "sendAt?": "Date",
      "pinnedAt?": "Date",
      "isDraft?": "boolean",
      "timestamp?": "Date",
      "ticketIds?": [
        "example string"
      ],
      "suggestedReply?": "string",
      "phoneNumber?": "string",
      "enduserPhoneNumber?": "string",
      "tags?": [
        "example string"
      ],
      "batchId?": "string"
    }
  ]
}

Update SmsMessage

Method: PATCH

https://api.tellescope.com/v1/sms-message/:id

Updates SmsMessage fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "logOnly?": "boolean",
    "message?": "string",
    "userId?": "string",
    "inbound?": "boolean",
    "readBy?": { string: Date },
    "hiddenBy?": { string: Date },
    "templateId?": "string",
    "automationStepId?": "string",
    "linkOpenTrackingIds?": [
      "example string"
    ],
    "journeyContext?": {
      "calendarEventId": "string",
      "formResponseId": "string",
      "purchaseId": "string"
    },
    "sendAt?": "Date",
    "pinnedAt?": "Date",
    "isDraft?": "boolean",
    "timestamp?": "Date",
    "ticketIds?": [
      "example string"
    ],
    "suggestedReply?": "string",
    "phoneNumber?": "string",
    "enduserPhoneNumber?": "string",
    "tags?": [
      "example string"
    ],
    "batchId?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get SmsMessage

Method: GET

https://api.tellescope.com/v1/sms-message/:id

Get an SmsMessage

{
  "filter?": {}
}

Get SmsMessages

Method: GET

https://api.tellescope.com/v1/sms-messages

Get a page of SmsMessages

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

Delete SmsMessage

Method: DELETE

https://api.tellescope.com/v1/sms-message/:id

Delete one SmsMessage

Authentication info only

SuperbillProviders

Create SuperbillProvider

Method: POST

https://api.tellescope.com/v1/superbill-provider

Creates a new SuperbillProvider

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "address": {
    "city": "string",
    "state": "string",
    "lineOne": "string",
    "lineTwo": "string",
    "zipPlusFour": "string"
  },
  "email": "string",
  "phone": "string",
  "officeName": "string",
  "taxId": "string",
  "providerName": "string",
  "placeOfServiceCode": "string",
  "providerLicense": "string",
  "providerNPI": "string"
}

Create SuperbillProviders

Method: POST

https://api.tellescope.com/v1/superbill-providers

Creates new SuperbillProviders

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "address": {
        "city": "string",
        "state": "string",
        "lineOne": "string",
        "lineTwo": "string",
        "zipPlusFour": "string"
      },
      "email": "string",
      "phone": "string",
      "officeName": "string",
      "taxId": "string",
      "providerName": "string",
      "placeOfServiceCode": "string",
      "providerLicense": "string",
      "providerNPI": "string"
    }
  ]
}

Update SuperbillProvider

Method: PATCH

https://api.tellescope.com/v1/superbill-provider/:id

Updates SuperbillProvider fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "address?": {
      "city": "string",
      "state": "string",
      "lineOne": "string",
      "lineTwo": "string",
      "zipPlusFour": "string"
    },
    "email?": "string",
    "phone?": "string",
    "officeName?": "string",
    "taxId?": "string",
    "providerName?": "string",
    "placeOfServiceCode?": "string",
    "providerLicense?": "string",
    "providerNPI?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get SuperbillProvider

Method: GET

https://api.tellescope.com/v1/superbill-provider/:id

Get an SuperbillProvider

{
  "filter?": {}
}

Get SuperbillProviders

Method: GET

https://api.tellescope.com/v1/superbill-providers

Get a page of SuperbillProviders

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

Delete SuperbillProvider

Method: DELETE

https://api.tellescope.com/v1/superbill-provider/:id

Delete one SuperbillProvider

Authentication info only

Superbills

Create Superbill

Method: POST

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

Creates a new Superbill

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "appointmentDate": "Date",
  "patient": {
    "dateOfBirth": "string",
    "name": "string",
    "phone": "string"
  },
  "provider": {
    "address": {
      "city": "string",
      "state": "string",
      "lineOne": "string",
      "lineTwo": "string",
      "zipPlusFour": "string"
    },
    "email": "string",
    "officeName": "string",
    "phone": "string",
    "placeOfServiceCode": "string",
    "providerLicense": "string",
    "providerName": "string",
    "providerNPI": "string",
    "taxId": "string"
  },
  "lineItems": [
    {
      "billingCode": {
        "code": -10000000000000,
        "label": "example string"
      },
      "quantity": -10000000000000,
      "cost": {
        "amount": -10000000000000,
        "currency": "example string"
      },
      "discount": -10000000000000
    }
  ]
}

Create Superbills

Method: POST

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

Creates new Superbills

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "appointmentDate": "Date",
      "patient": {
        "dateOfBirth": "string",
        "name": "string",
        "phone": "string"
      },
      "provider": {
        "address": {
          "city": "string",
          "state": "string",
          "lineOne": "string",
          "lineTwo": "string",
          "zipPlusFour": "string"
        },
        "email": "string",
        "officeName": "string",
        "phone": "string",
        "placeOfServiceCode": "string",
        "providerLicense": "string",
        "providerName": "string",
        "providerNPI": "string",
        "taxId": "string"
      },
      "lineItems": [
        {
          "billingCode": {
            "code": -10000000000000,
            "label": "example string"
          },
          "quantity": -10000000000000,
          "cost": {
            "amount": -10000000000000,
            "currency": "example string"
          },
          "discount": -10000000000000
        }
      ]
    }
  ]
}

Update Superbill

Method: PATCH

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

Updates Superbill fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "enduserId?": "string",
    "appointmentDate?": "Date",
    "patient?": {
      "dateOfBirth": "string",
      "name": "string",
      "phone": "string"
    },
    "provider?": {
      "address": {
        "city": "string",
        "state": "string",
        "lineOne": "string",
        "lineTwo": "string",
        "zipPlusFour": "string"
      },
      "email": "string",
      "officeName": "string",
      "phone": "string",
      "placeOfServiceCode": "string",
      "providerLicense": "string",
      "providerName": "string",
      "providerNPI": "string",
      "taxId": "string"
    },
    "lineItems?": [
      {
        "billingCode": {
          "code": -10000000000000,
          "label": "example string"
        },
        "quantity": -10000000000000,
        "cost": {
          "amount": -10000000000000,
          "currency": "example string"
        },
        "discount": -10000000000000
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Superbill

Method: GET

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

Get an Superbill

{
  "filter?": {}
}

Get Superbills

Method: GET

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

Get a page of Superbills

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

Delete Superbill

Method: DELETE

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

Delete one Superbill

Authentication info only

TableViews

Create TableView

Method: POST

https://api.tellescope.com/v1/table-view

Creates a new TableView

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "page": "string",
  "columns": [
    {
      "width": -10000000000000,
      "type": "example string"
    }
  ],
  "defaultForRoles?": [
    "example string"
  ],
  "defaultForUserIds?": [
    "example string"
  ],
  "filter?": { "key": string }
}

Create TableViews

Method: POST

https://api.tellescope.com/v1/table-views

Creates new TableViews

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "page": "string",
      "columns": [
        {
          "width": -10000000000000,
          "type": "example string"
        }
      ],
      "defaultForRoles?": [
        "example string"
      ],
      "defaultForUserIds?": [
        "example string"
      ],
      "filter?": { "key": string }
    }
  ]
}

Update TableView

Method: PATCH

https://api.tellescope.com/v1/table-view/:id

Updates TableView fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "page?": "string",
    "columns?": [
      {
        "width": -10000000000000,
        "type": "example string"
      }
    ],
    "defaultForRoles?": [
      "example string"
    ],
    "defaultForUserIds?": [
      "example string"
    ],
    "filter?": { "key": string }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get TableView

Method: GET

https://api.tellescope.com/v1/table-view/:id

Get an TableView

{
  "filter?": {}
}

Get TableViews

Method: GET

https://api.tellescope.com/v1/table-views

Get a page of TableViews

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

Delete TableView

Method: DELETE

https://api.tellescope.com/v1/table-view/:id

Delete one TableView

Authentication info only

Templates

Constraints

  • title must be unique across Templates

Get templated message

Method: POST

https://api.tellescope.com/v1/templated-message

Returns a message with template values replaced. Uses POST to support large bodies.

{
  "message": "string",
  "userId": "string",
  "enduserId": "string",
  "html?": "string",
  "subject?": "string",
  "channel?": "string",
  "automationStepId?": "string",
  "journeyContext?": {
    "calendarEventId": "string",
    "formResponseId": "string",
    "purchaseId": "string"
  }
}

Get suggested reply

Method: POST

https://api.tellescope.com/v1/templates/suggested-reply

Returns an AI-generated suggested reply to a conversation.

{
  "messages": [
    {
      "role": "assistant",
      "content": "example string"
    }
  ]
}

Generate Embedding

Method: POST

https://api.tellescope.com/v1/templates/create-embedding

Generates an embedding for AI search

{
  "templateId": "string"
}

Embedding Search

Method: POST

https://api.tellescope.com/v1/templates/embedding-search

Performs an AI search

{
  "content": "string"
}

Create Template

Method: POST

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

Creates a new Template

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "subject": "string",
  "message": "string",
  "html?": "string",
  "editorState?": "string",
  "type?": "string",
  "mode?": "string",
  "isMarketing?": "boolean"
}

Create Templates

Method: POST

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

Creates new Templates

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "subject": "string",
      "message": "string",
      "html?": "string",
      "editorState?": "string",
      "type?": "string",
      "mode?": "string",
      "isMarketing?": "boolean"
    }
  ]
}

Update Template

Method: PATCH

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

Updates Template fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "subject?": "string",
    "message?": "string",
    "html?": "string",
    "editorState?": "string",
    "type?": "string",
    "mode?": "string",
    "isMarketing?": "boolean"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Template

Method: GET

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

Get an Template

{
  "filter?": {}
}

Get Templates

Method: GET

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

Get a page of Templates

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

Delete Template

Method: DELETE

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

Delete one Template

Authentication info only

TicketQueues

Constraints

  • title must be unique across TicketQueues

Create TicketQueue

Method: POST

https://api.tellescope.com/v1/ticket-queue

Creates a new TicketQueue

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

Create TicketQueues

Method: POST

https://api.tellescope.com/v1/ticket-queues

Creates new TicketQueues

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

Update TicketQueue

Method: PATCH

https://api.tellescope.com/v1/ticket-queue/:id

Updates TicketQueue fields

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

Get TicketQueue

Method: GET

https://api.tellescope.com/v1/ticket-queue/:id

Get an TicketQueue

{
  "filter?": {}
}

Get TicketQueues

Method: GET

https://api.tellescope.com/v1/ticket-queues

Get a page of TicketQueues

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

Delete TicketQueue

Method: DELETE

https://api.tellescope.com/v1/ticket-queue/:id

Delete one TicketQueue

Authentication info only

Tickets

Constraints

  • When created by an enduser, enduserId must match their id

Assign From Queue

Method: PATCH

https://api.tellescope.com/v1/tickets/assign-from-queue

Takes a ticket from a queue and assigns to the caller of this endpoint

{
  "ticketId": "string"
}

Update Indexes

Method: PATCH

https://api.tellescope.com/v1/tickets/update-indexes

Updates indexes for a number of tickets to adjust the default sorting

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

Get Report

Method: ALL

https://api.tellescope.com/v1/tickets/report

Gets aggregate data for building a report on tickets

{
  "userId?": "string",
  "title?": "string",
  "titles?": [
    "example string"
  ],
  "range?": {
    "from": "Date",
    "to": "Date"
  },
  "groupByOwnerAndTitle?": "boolean"
}

Get Report

Method: ALL

https://api.tellescope.com/v1/tickets/distribution-report

Gets aggregate data for a report on ticket distributions

{
  "range?": {
    "from": "Date",
    "to": "Date"
  }
}

Close Ticket

Method: POST

https://api.tellescope.com/v1/tickets/close

Closes a ticket and returns any resulting tickets for a current journey

{
  "ticketId?": "string",
  "closedForReason?": "string"
}

Create Ticket

Method: POST

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

Creates a new Ticket

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "enduserId?": "string",
  "automationStepId?": "string",
  "closedForReason?": "string",
  "closeReasons?": [
    "example string"
  ],
  "closedBy?": "string",
  "chatRoomId?": "string",
  "dueDateInMS?": "number",
  "closedAt?": "Date",
  "owner?": "string",
  "message?": "string",
  "skillsRequired?": [
    "example string"
  ],
  "priority?": "number",
  "blockerDescription?": "string",
  "index?": "number",
  "carePlanId?": "string",
  "journeyId?": "string",
  "purchaseId?": "string",
  "hiddenFromTickets?": "boolean",
  "htmlDescription?": "string",
  "formResponseIds?": [
    "example string"
  ],
  "actions?": [
    {
      "type": "Complete Form",
      "info": {
        "formId": "60398b0231a295e64f084fd9",
        "formResponseId": "60398b0231a295e64f084fd9"
      },
      "completedAt": "2024-03-29T07:14:28.665Z"
    }
  ],
  "closeOnFinishedActions?": "boolean",
  "remindAt?": "Date",
  "reminderSilencedAt?": "Date",
  "relatedRecords?": [
    {
      "id": "60398b0231a295e64f084fd9",
      "creator": "60398b0231a295e64f084fd9",
      "environment": "example string"
    }
  ],
  "attachments?": [
    {
      "name": "example string",
      "secureName": "example string"
    }
  ],
  "snoozes?": [
    {
      "at": "2024-03-29T07:14:28.665Z",
      "until": "2024-03-29T07:14:28.665Z"
    }
  ],
  "requireConfirmation?": "boolean",
  "queueId?": "string",
  "reminders?": [
    {
      "msBeforeDueDate": -10000000000000,
      "didRemind": true
    }
  ]
}

Create Tickets

Method: POST

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

Creates new Tickets

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "enduserId?": "string",
      "automationStepId?": "string",
      "closedForReason?": "string",
      "closeReasons?": [
        "example string"
      ],
      "closedBy?": "string",
      "chatRoomId?": "string",
      "dueDateInMS?": "number",
      "closedAt?": "Date",
      "owner?": "string",
      "message?": "string",
      "skillsRequired?": [
        "example string"
      ],
      "priority?": "number",
      "blockerDescription?": "string",
      "index?": "number",
      "carePlanId?": "string",
      "journeyId?": "string",
      "purchaseId?": "string",
      "hiddenFromTickets?": "boolean",
      "htmlDescription?": "string",
      "formResponseIds?": [
        "example string"
      ],
      "actions?": [
        {
          "type": "Complete Form",
          "info": {
            "formId": "60398b0231a295e64f084fd9",
            "formResponseId": "60398b0231a295e64f084fd9"
          },
          "completedAt": "2024-03-29T07:14:28.665Z"
        }
      ],
      "closeOnFinishedActions?": "boolean",
      "remindAt?": "Date",
      "reminderSilencedAt?": "Date",
      "relatedRecords?": [
        {
          "id": "60398b0231a295e64f084fd9",
          "creator": "60398b0231a295e64f084fd9",
          "environment": "example string"
        }
      ],
      "attachments?": [
        {
          "name": "example string",
          "secureName": "example string"
        }
      ],
      "snoozes?": [
        {
          "at": "2024-03-29T07:14:28.665Z",
          "until": "2024-03-29T07:14:28.665Z"
        }
      ],
      "requireConfirmation?": "boolean",
      "queueId?": "string",
      "reminders?": [
        {
          "msBeforeDueDate": -10000000000000,
          "didRemind": true
        }
      ]
    }
  ]
}

Update Ticket

Method: PATCH

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

Updates Ticket fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "enduserId?": "string",
    "automationStepId?": "string",
    "closedForReason?": "string",
    "closeReasons?": [
      "example string"
    ],
    "closedBy?": "string",
    "chatRoomId?": "string",
    "dueDateInMS?": "number",
    "closedAt?": "Date",
    "owner?": "string",
    "message?": "string",
    "skillsRequired?": [
      "example string"
    ],
    "priority?": "number",
    "blockerDescription?": "string",
    "index?": "number",
    "carePlanId?": "string",
    "journeyId?": "string",
    "purchaseId?": "string",
    "hiddenFromTickets?": "boolean",
    "htmlDescription?": "string",
    "formResponseIds?": [
      "example string"
    ],
    "actions?": [
      {
        "type": "Complete Form",
        "info": {
          "formId": "60398b0231a295e64f084fd9",
          "formResponseId": "60398b0231a295e64f084fd9"
        },
        "completedAt": "2024-03-29T07:14:28.665Z"
      }
    ],
    "closeOnFinishedActions?": "boolean",
    "remindAt?": "Date",
    "reminderSilencedAt?": "Date",
    "relatedRecords?": [
      {
        "id": "60398b0231a295e64f084fd9",
        "creator": "60398b0231a295e64f084fd9",
        "environment": "example string"
      }
    ],
    "attachments?": [
      {
        "name": "example string",
        "secureName": "example string"
      }
    ],
    "snoozes?": [
      {
        "at": "2024-03-29T07:14:28.665Z",
        "until": "2024-03-29T07:14:28.665Z"
      }
    ],
    "requireConfirmation?": "boolean",
    "queueId?": "string",
    "reminders?": [
      {
        "msBeforeDueDate": -10000000000000,
        "didRemind": true
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Ticket

Method: GET

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

Get an Ticket

{
  "filter?": {}
}

Get Tickets

Method: GET

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

Get a page of Tickets

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

Delete Ticket

Method: DELETE

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

Delete one Ticket

Authentication info only

TicketThreadComments

For Zendesk integration

Create TicketThreadComment

Method: POST

https://api.tellescope.com/v1/ticket-thread-comment

Creates a new TicketThreadComment

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "ticketThreadId": "string",
  "public": "boolean",
  "plaintext?": "string",
  "html?": "string",
  "attachments?": [
    {
      "name": "example string",
      "secureName": "example string"
    }
  ],
  "enduserId?": "string",
  "userId?": "string",
  "inbound?": "boolean",
  "readBy?": { string: Date },
  "hiddenBy?": { string: Date },
  "ticketIds?": [
    "example string"
  ],
  "group?": "string"
}

Create TicketThreadComments

Method: POST

https://api.tellescope.com/v1/ticket-thread-comments

Creates new TicketThreadComments

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "ticketThreadId": "string",
      "public": "boolean",
      "plaintext?": "string",
      "html?": "string",
      "attachments?": [
        {
          "name": "example string",
          "secureName": "example string"
        }
      ],
      "enduserId?": "string",
      "userId?": "string",
      "inbound?": "boolean",
      "readBy?": { string: Date },
      "hiddenBy?": { string: Date },
      "ticketIds?": [
        "example string"
      ],
      "group?": "string"
    }
  ]
}

Update TicketThreadComment

Method: PATCH

https://api.tellescope.com/v1/ticket-thread-comment/:id

Updates TicketThreadComment fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "ticketThreadId?": "string",
    "public?": "boolean",
    "plaintext?": "string",
    "html?": "string",
    "attachments?": [
      {
        "name": "example string",
        "secureName": "example string"
      }
    ],
    "enduserId?": "string",
    "userId?": "string",
    "inbound?": "boolean",
    "readBy?": { string: Date },
    "hiddenBy?": { string: Date },
    "ticketIds?": [
      "example string"
    ],
    "group?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get TicketThreadComment

Method: GET

https://api.tellescope.com/v1/ticket-thread-comment/:id

Get an TicketThreadComment

{
  "filter?": {}
}

Get TicketThreadComments

Method: GET

https://api.tellescope.com/v1/ticket-thread-comments

Get a page of TicketThreadComments

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

Delete TicketThreadComment

Method: DELETE

https://api.tellescope.com/v1/ticket-thread-comment/:id

Delete one TicketThreadComment

Authentication info only

TicketThreads

For Zendesk integration

Create TicketThread

Method: POST

https://api.tellescope.com/v1/ticket-thread

Creates a new TicketThread

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "enduserId": "string",
  "subject?": "string",
  "pinnedAt?": "Date",
  "group?": "string"
}

Create TicketThreads

Method: POST

https://api.tellescope.com/v1/ticket-threads

Creates new TicketThreads

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "enduserId": "string",
      "subject?": "string",
      "pinnedAt?": "Date",
      "group?": "string"
    }
  ]
}

Update TicketThread

Method: PATCH

https://api.tellescope.com/v1/ticket-thread/:id

Updates TicketThread fields

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

Get TicketThread

Method: GET

https://api.tellescope.com/v1/ticket-thread/:id

Get an TicketThread

{
  "filter?": {}
}

Get TicketThreads

Method: GET

https://api.tellescope.com/v1/ticket-threads

Get a page of TicketThreads

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

Delete TicketThread

Method: DELETE

https://api.tellescope.com/v1/ticket-thread/:id

Delete one TicketThread

Authentication info only

UserLogs

Get UserLog

Method: GET

https://api.tellescope.com/v1/user-log/:id

Get an UserLog

{
  "filter?": {}
}

Get UserLogs

Method: GET

https://api.tellescope.com/v1/user-logs

Get a page of UserLogs

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

UserNotifications

Send Team Email Notification

Method: POST

https://api.tellescope.com/v1/send-user-email-notification

Sends an email notification to a team member (user)

{
  "userId": "string",
  "message": "string",
  "subject?": "string"
}

Bulk update (read or delete)

Method: POST

https://api.tellescope.com/v1/notifications/bulk-update

Marks all as read, or deletes all notifications

{
  "action?": "string"
}

Create UserNotification

Method: POST

https://api.tellescope.com/v1/user-notification

Creates a new UserNotification

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "userId": "string",
  "message": "string",
  "read?": "boolean",
  "relatedRecords?": [
    {
      "id": "60398b0231a295e64f084fd9",
      "creator": "60398b0231a295e64f084fd9",
      "environment": "example string"
    }
  ]
}

Create UserNotifications

Method: POST

https://api.tellescope.com/v1/user-notifications

Creates new UserNotifications

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "userId": "string",
      "message": "string",
      "read?": "boolean",
      "relatedRecords?": [
        {
          "id": "60398b0231a295e64f084fd9",
          "creator": "60398b0231a295e64f084fd9",
          "environment": "example string"
        }
      ]
    }
  ]
}

Update UserNotification

Method: PATCH

https://api.tellescope.com/v1/user-notification/:id

Updates UserNotification fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "userId?": "string",
    "message?": "string",
    "read?": "boolean",
    "relatedRecords?": [
      {
        "id": "60398b0231a295e64f084fd9",
        "creator": "60398b0231a295e64f084fd9",
        "environment": "example string"
      }
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get UserNotification

Method: GET

https://api.tellescope.com/v1/user-notification/:id

Get an UserNotification

{
  "filter?": {}
}

Get UserNotifications

Method: GET

https://api.tellescope.com/v1/user-notifications

Get a page of UserNotifications

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

Delete UserNotification

Method: DELETE

https://api.tellescope.com/v1/user-notification/:id

Delete one UserNotification

Authentication info only

Users

Used to represent your team member accounts. See Endusers for representing patients and other types of stakeholders.

Constraints

  • username must be unique across Users
  • Only admin users can set the admin role
  • Only admin users can update others' profiles
  • Only admin users can update tags when accessTags is enabled
  • Only admin users can update user roles
  • Only admin users can update user lockouts
  • User organizationIds are readonly

Register (Public)

Method: POST

https://api.tellescope.com/v1/users/register

Registers a new account

{
  "email": "string",
  "inviteCode?": "string"
}

Login (Public)

Method: POST

https://api.tellescope.com/v1/users/login

Login with email and password

{
  "email": "string",
  "expirationInSeconds?": "number"
}

Login with Google (Public)

Method: POST

https://api.tellescope.com/v1/users/login-google

Login with Google

{
  "jwt": "string"
}

Request Password Reset (Public)

Method: POST

https://api.tellescope.com/v1/request-password-reset

Sends a password reset email

{
  "email": "string"
}

Reset Password (Public)

Method: POST

https://api.tellescope.com/v1/reset-password

For a code generated by request-password-reset, sets a new password

{
  "resetToken": "string",
  "newPassword": "string"
}

Submit Email Verification (Public)

Method: POST

https://api.tellescope.com/v1/users/submit-email-verification

Verifies a user's email address

{
  "email": "string",
  "code": "string"
}

Invite User (Admin Only)

Method: POST

https://api.tellescope.com/v1/invite-user-to-organization

Invites a user to register for the given (sub)-organization

{
  "email": "string",
  "fname": "string",
  "lname": "string",
  "internalDisplayName?": "string",
  "organizationId": "string",
  "role?": "string",
  "tags?": [
    "example string"
  ]
}

Invite user to join organization (Admin Only)

Method: POST

https://api.tellescope.com/v1/invite-existing-user-to-organization

Invites a user to join the current (sub)organization

{
  "userId": "string"
}

Generate authToken (Admin Only)

Method: GET

https://api.tellescope.com/v1/generate-auth-token

Generates an authToken for a user or enduser. Useful for integrating a 3rd-party authentication process.

{
  "id?": "string",
  "externalId?": "string",
  "email?": "string",
  "phone?": "string",
  "durationInSeconds?": "number"
}

User Display Info

Method: GET

https://api.tellescope.com/v1/user-display-info

Gets display info for users, accessible by endusers

Authentication info only

Refresh user authentication

Method: POST

https://api.tellescope.com/v1/refresh-session

When called by an authenticated user, generates a new session

{
  "invalidatePreviousToken?": "boolean"
}

Configure MFA

Method: POST

https://api.tellescope.com/v1/users/configure-mfa

Configures MFA

Authentication info only

Generate MFA Challenge

Method: POST

https://api.tellescope.com/v1/users/generate-mfa-challenge

Begins the MFA verification process, e.g. by sending an email with a code

{}

Submit MFA Challenge

Method: POST

https://api.tellescope.com/v1/users/submit-mfa-challenge

Completes the MFA verification process and generates a new auth token

{}

Get Engagement Report

Method: GET

https://api.tellescope.com/v1/users/get-engagement-report

Gets a report on engagement by care team

{
  "range?": {
    "from": "Date",
    "to": "Date"
  }
}

Configure Inbox

Method: POST

https://api.tellescope.com/v1/users/configure-inbox

Configured inbox to support built-in email server

{
  "username": "string",
  "fname": "string",
  "lname": "string"
}

Create User (Admin Only)

Method: POST

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

Creates a new User

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "email": "string",
  "phone?": "string",
  "fields?": {},
  "unredactedFields?": {},
  "externalId?": "string",
  "fname?": "string",
  "lname?": "string",
  "displayName?": "string",
  "suffixes?": [
    "example string"
  ],
  "organization?": "string",
  "roles?": [
    "example string"
  ],
  "acknowledgedIntegrations?": "Date",
  "disableIncomingPhoneCalls?": "boolean",
  "skills?": [
    "example string"
  ],
  "verifiedEmail?": "boolean",
  "notificationPreferences?": { "key": [object Object] },
  "notificationEmailsDisabled?": "boolean",
  "avatar?": "string",
  "credentialedStates?": [
    {
      "expiresAt": "2024-03-29T07:14:28.663Z",
      "licenseId": "example string",
      "state": "AK"
    }
  ],
  "timezone?": "string",
  "weeklyAvailabilities?": [
    {
      "dayOfWeekStartingSundayIndexedByZero": 0,
      "endTimeInMinutes": 0,
      "startTimeInMinutes": 0,
      "locationId": "60398b0231a295e64f084fd9",
      "active": {
        "from": "2024-03-29T07:14:28.663Z",
        "to": "2024-03-29T07:14:28.663Z"
      },
      "validTemplateIds": [
        "60398b0231a295e64f084fd9"
      ]
    }
  ],
  "autoReplyEnabled?": "boolean",
  "pushNotificationIosTokens?": [
    "example string"
  ],
  "callRouting?": "string",
  "tags?": [
    "example string"
  ],
  "emailSignature?": "string",
  "disableTicketAutoAssignment?": "boolean",
  "ticketAssignmentPriority?": "number",
  "specialties?": [
    "example string"
  ],
  "bio?": "string",
  "TIN?": "string",
  "NPI?": "string",
  "DEA?": "string",
  "voicemailPlayback?": [
    [
      {
        "type": "string",
        "info": {
          "url": "string",
          "script": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "script": "string",
          "url": "string"
        }
      },
      { }
    ]
  ],
  "lockedOutUntil?": "number"
}

Create Users (Admin Only)

Method: POST

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

Creates new Users

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "email": "string",
      "phone?": "string",
      "fields?": {},
      "unredactedFields?": {},
      "externalId?": "string",
      "fname?": "string",
      "lname?": "string",
      "displayName?": "string",
      "suffixes?": [
        "example string"
      ],
      "organization?": "string",
      "roles?": [
        "example string"
      ],
      "acknowledgedIntegrations?": "Date",
      "disableIncomingPhoneCalls?": "boolean",
      "skills?": [
        "example string"
      ],
      "verifiedEmail?": "boolean",
      "notificationPreferences?": { "key": [object Object] },
      "notificationEmailsDisabled?": "boolean",
      "avatar?": "string",
      "credentialedStates?": [
        {
          "expiresAt": "2024-03-29T07:14:28.663Z",
          "licenseId": "example string",
          "state": "AK"
        }
      ],
      "timezone?": "string",
      "weeklyAvailabilities?": [
        {
          "dayOfWeekStartingSundayIndexedByZero": 0,
          "endTimeInMinutes": 0,
          "startTimeInMinutes": 0,
          "locationId": "60398b0231a295e64f084fd9",
          "active": {
            "from": "2024-03-29T07:14:28.663Z",
            "to": "2024-03-29T07:14:28.663Z"
          },
          "validTemplateIds": [
            "60398b0231a295e64f084fd9"
          ]
        }
      ],
      "autoReplyEnabled?": "boolean",
      "pushNotificationIosTokens?": [
        "example string"
      ],
      "callRouting?": "string",
      "tags?": [
        "example string"
      ],
      "emailSignature?": "string",
      "disableTicketAutoAssignment?": "boolean",
      "ticketAssignmentPriority?": "number",
      "specialties?": [
        "example string"
      ],
      "bio?": "string",
      "TIN?": "string",
      "NPI?": "string",
      "DEA?": "string",
      "voicemailPlayback?": [
        [
          {
            "type": "string",
            "info": {
              "url": "string",
              "script": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "script": "string",
              "url": "string"
            }
          },
          { }
        ]
      ],
      "lockedOutUntil?": "number"
    }
  ]
}

Delete User (Admin Only)

Method: DELETE

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

Delete one User

Authentication info only

Get User

Method: GET

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

Get an User

{
  "filter?": {}
}

Get Users

Method: GET

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

Get a page of Users

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

Update User

Method: PATCH

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

Users can only be updated by self or an organization admin

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "email?": "string",
    "phone?": "string",
    "fields?": {},
    "unredactedFields?": {},
    "externalId?": "string",
    "fname?": "string",
    "lname?": "string",
    "displayName?": "string",
    "suffixes?": [
      "example string"
    ],
    "roles?": [
      "example string"
    ],
    "acknowledgedIntegrations?": "Date",
    "disableIncomingPhoneCalls?": "boolean",
    "skills?": [
      "example string"
    ],
    "notificationPreferences?": { "key": [object Object] },
    "notificationEmailsDisabled?": "boolean",
    "avatar?": "string",
    "credentialedStates?": [
      {
        "expiresAt": "2024-03-29T07:14:28.663Z",
        "licenseId": "example string",
        "state": "AK"
      }
    ],
    "timezone?": "string",
    "weeklyAvailabilities?": [
      {
        "dayOfWeekStartingSundayIndexedByZero": 0,
        "endTimeInMinutes": 0,
        "startTimeInMinutes": 0,
        "locationId": "60398b0231a295e64f084fd9",
        "active": {
          "from": "2024-03-29T07:14:28.663Z",
          "to": "2024-03-29T07:14:28.663Z"
        },
        "validTemplateIds": [
          "60398b0231a295e64f084fd9"
        ]
      }
    ],
    "autoReplyEnabled?": "boolean",
    "pushNotificationIosTokens?": [
      "example string"
    ],
    "callRouting?": "string",
    "tags?": [
      "example string"
    ],
    "emailSignature?": "string",
    "disableTicketAutoAssignment?": "boolean",
    "ticketAssignmentPriority?": "number",
    "specialties?": [
      "example string"
    ],
    "bio?": "string",
    "TIN?": "string",
    "NPI?": "string",
    "DEA?": "string",
    "voicemailPlayback?": [
      [
        {
          "type": "string",
          "info": {
            "url": "string",
            "script": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "script": "string",
            "url": "string"
          }
        },
        { }
      ]
    ],
    "lockedOutUntil?": "number"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Webhooks

Allows you to subscribe to Webhooks when models in Tellescope are created, updated, and deleted.

To avoid echo (receiving webhooks when updating records with an API Key), pass the use { dontSendWebhook: true } in the "options" parameter to the update request

Each webhook is a POST request to the given URL, of the form
{ 
model: string,
type: 'create' | 'update' | 'delete',
records: object[],
timestamp: string,
integrity: string,
relatedRecords: { [id: string]: object }
}

This includes the name of the model, the type of operation performed, and an array of the new, updated, or deleted model(s).

The integrity field is a sha256 hash of (record ids concatenated from index 0 to the end, with the timestamp and then secret appended)
For example hook: { records: [{ id: '1', ... }, { id: '4', ... }], timestamp: "1029358" } with secret set as "secret",
integrity = sha256('141029358secret')
Each time you handle a webhook, you should verify the integrity field is correct to ensure that the request is actually coming from Tellescope.

For performance, a relatedRecords object is provided as a cache. This object maps some ids referenced in the webhook records to the corresponding models in Tellescope.
For a given webhook, relatedRecords may be empty, or may not include all related ids. In such cases, you'll need to query against the Tellescope API for an up-to-date reference.

Currently supported models for Webhooks: enduser_encounters, enduser_orders, group_mms_conversations, ticket_queues, configurations, ticket_thread_comments, ticket_threads, enduser_custom_types, phone_trees, referral_providers, enduser_medications, superbill_providers, superbills, automation_triggers, background_errors, enduser_views, availability_blocks, analytics_frames, endusers, enduser_status_updates, engagement_events, journeys, emails, sms_messages, chat_rooms, chats, users, templates, files, tickets, meetings, notes, forms, form_fields, form_responses, calendar_events, calendar_event_templates, calendar_event_RSVPs, automation_steps, automated_actions, webhooks, user_logs, user_notifications, enduser_observations, managed_content_records, managed_content_record_assignments, forums, forum_posts, post_likes, comment_likes, post_comments, organizations, databases, database_records, portal_customizations, care_plans, enduser_tasks, role_based_access_permissions, appointment_booking_pages, appointment_locations, products, purchases, purchase_credits, phone_calls, enduser_profile_views, table_views, email_sync_denials

You can handle webhooks from automations in Tellescope, which have a simpler format:
{ 
type: 'automation'
message: string,
timestamp: string,
integrity: string,
enduserId: string,
}

In this case, integrity is a simple sha256 hash of message + timestamp + secret

You can also handle calendar event reminders as webhooks, which have the format:
{ 
type: 'calendar_event_reminder'
event: CalendarEvent,
timestamp: string,
integrity: string,
}

In this case, integrity is a simple sha256 hash of event.id + timestamp + secret

Configure Webhooks (Admin Only)

Method: POST

https://api.tellescope.com/v1/configure-webhooks

Sets the URL, secret, and initial subscriptions for your organization. Your secret must exceed 15 characters and should be generated randomly. This endpoint ensures duplicate webhook records aren't created.

{
  "url": "string",
  "secret": "string",
  "subscriptions?": {
    "enduser_encounters": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_orders": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "group_mms_conversations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_queues": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "configurations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_thread_comments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_threads": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_custom_types": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "phone_trees": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "referral_providers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_medications": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "superbill_providers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "superbills": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automation_triggers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "background_errors": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "availability_blocks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "analytics_frames": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "endusers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_status_updates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "engagement_events": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "journeys": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "emails": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "sms_messages": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "chat_rooms": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "chats": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "users": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "templates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "files": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "tickets": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "meetings": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "notes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forms": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "form_fields": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "form_responses": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_events": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_event_templates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_event_RSVPs": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automation_steps": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automated_actions": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "webhooks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "user_logs": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "user_notifications": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_observations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "managed_content_records": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "managed_content_record_assignments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forums": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forum_posts": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "post_likes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "comment_likes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "post_comments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "organizations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "databases": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "database_records": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "portal_customizations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "care_plans": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_tasks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "role_based_access_permissions": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "appointment_booking_pages": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "appointment_locations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "products": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "purchases": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "purchase_credits": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "phone_calls": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_profile_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "table_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "email_sync_denials": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    }
  }
}

Get current configuration info

Method: GET

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

DEPRECATED: Returns current webhook configuration

Authentication info only

Update Webhooks (Admin Only)

Method: PATCH

https://api.tellescope.com/v1/update-webhooks

DEPRECATED: Modifies only subscriptions to models included in subscriptionUpdates. To remove subscriptions for a given model, set all values to false.

{
  "url?": "string",
  "secret?": "string",
  "subscriptionUpdates?": {
    "enduser_encounters": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_orders": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "group_mms_conversations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_queues": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "configurations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_thread_comments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_threads": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_custom_types": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "phone_trees": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "referral_providers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_medications": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "superbill_providers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "superbills": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automation_triggers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "background_errors": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "availability_blocks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "analytics_frames": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "endusers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_status_updates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "engagement_events": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "journeys": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "emails": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "sms_messages": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "chat_rooms": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "chats": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "users": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "templates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "files": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "tickets": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "meetings": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "notes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forms": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "form_fields": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "form_responses": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_events": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_event_templates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_event_RSVPs": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automation_steps": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automated_actions": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "webhooks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "user_logs": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "user_notifications": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_observations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "managed_content_records": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "managed_content_record_assignments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forums": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forum_posts": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "post_likes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "comment_likes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "post_comments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "organizations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "databases": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "database_records": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "portal_customizations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "care_plans": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_tasks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "role_based_access_permissions": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "appointment_booking_pages": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "appointment_locations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "products": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "purchases": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "purchase_credits": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "phone_calls": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_profile_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "table_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "email_sync_denials": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    }
  }
}

Send Automation Webhook

Method: POST

https://api.tellescope.com/v1/send-automation-webhook

Sends a webhook with the automations format, useful for testing automation integrations

{
  "message": "string",
  "enduserId?": "string"
}

Send Calendar Event Reminder Webhook

Method: POST

https://api.tellescope.com/v1/send-calendar-event-reminder-webhook

Sends a webhook with the calendar reminder format, useful for testing integrations

{
  "id": "string"
}

Create Webhook

Method: POST

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

Creates a new Webhook

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "secret?": "string",
  "url?": "string",
  "subscriptions?": {
    "enduser_encounters": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_orders": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "group_mms_conversations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_queues": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "configurations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_thread_comments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "ticket_threads": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_custom_types": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "phone_trees": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "referral_providers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_medications": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "superbill_providers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "superbills": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automation_triggers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "background_errors": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "availability_blocks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "analytics_frames": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "endusers": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_status_updates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "engagement_events": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "journeys": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "emails": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "sms_messages": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "chat_rooms": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "chats": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "users": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "templates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "files": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "tickets": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "meetings": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "notes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forms": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "form_fields": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "form_responses": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_events": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_event_templates": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "calendar_event_RSVPs": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automation_steps": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "automated_actions": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "webhooks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "user_logs": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "user_notifications": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_observations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "managed_content_records": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "managed_content_record_assignments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forums": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "forum_posts": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "post_likes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "comment_likes": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "post_comments": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "organizations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "databases": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "database_records": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "portal_customizations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "care_plans": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_tasks": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "role_based_access_permissions": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "appointment_booking_pages": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "appointment_locations": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "products": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "purchases": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "purchase_credits": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "phone_calls": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "enduser_profile_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "table_views": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    },
    "email_sync_denials": {
      "create": "boolean",
      "update": "boolean",
      "delete": "boolean"
    }
  }
}

Create Webhooks

Method: POST

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

Creates new Webhooks

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "secret?": "string",
      "url?": "string",
      "subscriptions?": {
        "enduser_encounters": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_orders": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "group_mms_conversations": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "ticket_queues": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "configurations": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "ticket_thread_comments": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "ticket_threads": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_custom_types": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "phone_trees": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "referral_providers": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_medications": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "superbill_providers": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "superbills": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "automation_triggers": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "background_errors": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_views": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "availability_blocks": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "analytics_frames": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "endusers": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_status_updates": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "engagement_events": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "journeys": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "emails": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "sms_messages": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "chat_rooms": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "chats": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "users": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "templates": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "files": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "tickets": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "meetings": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "notes": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "forms": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "form_fields": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "form_responses": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "calendar_events": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "calendar_event_templates": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "calendar_event_RSVPs": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "automation_steps": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "automated_actions": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "webhooks": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "user_logs": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "user_notifications": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_observations": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "managed_content_records": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "managed_content_record_assignments": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "forums": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "forum_posts": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "post_likes": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "comment_likes": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "post_comments": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "organizations": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "databases": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "database_records": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "portal_customizations": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "care_plans": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_tasks": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "role_based_access_permissions": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "appointment_booking_pages": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "appointment_locations": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "products": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "purchases": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "purchase_credits": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "phone_calls": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "enduser_profile_views": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "table_views": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        },
        "email_sync_denials": {
          "create": "boolean",
          "update": "boolean",
          "delete": "boolean"
        }
      }
    }
  ]
}

Update Webhook

Method: PATCH

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

Updates Webhook fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "secret?": "string",
    "url?": "string",
    "subscriptions?": {
      "enduser_encounters": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_orders": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "group_mms_conversations": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "ticket_queues": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "configurations": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "ticket_thread_comments": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "ticket_threads": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_custom_types": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "phone_trees": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "referral_providers": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_medications": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "superbill_providers": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "superbills": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "automation_triggers": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "background_errors": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_views": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "availability_blocks": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "analytics_frames": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "endusers": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_status_updates": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "engagement_events": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "journeys": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "emails": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "sms_messages": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "chat_rooms": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "chats": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "users": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "templates": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "files": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "tickets": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "meetings": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "notes": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "forms": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "form_fields": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "form_responses": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "calendar_events": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "calendar_event_templates": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "calendar_event_RSVPs": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "automation_steps": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "automated_actions": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "webhooks": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "user_logs": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "user_notifications": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_observations": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "managed_content_records": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "managed_content_record_assignments": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "forums": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "forum_posts": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "post_likes": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "comment_likes": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "post_comments": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "organizations": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "databases": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "database_records": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "portal_customizations": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "care_plans": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_tasks": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "role_based_access_permissions": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "appointment_booking_pages": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "appointment_locations": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "products": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "purchases": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "purchase_credits": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "phone_calls": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "enduser_profile_views": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "table_views": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      },
      "email_sync_denials": {
        "create": "boolean",
        "update": "boolean",
        "delete": "boolean"
      }
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Webhook

Method: GET

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

Get an Webhook

{
  "filter?": {}
}

Get Webhooks

Method: GET

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

Get a page of Webhooks

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

Delete Webhook

Method: DELETE

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

Delete one Webhook

Authentication info only