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.

Authentication

Include an API key (Secret Key) in each request with the apiKey parameter.
You may also 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 the { replaceObjectFields: true } option.

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

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": "2023-05-29T20:17:34.983Z",
                "to": "2023-05-29T20:17:34.983Z"
              }
            }
          ],
          "Submitted Forms": {
            "qualifier": "string",
            "formIds": [
              "60398b0231a295e64f084fd9"
            ],
            "formResponseCondition": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          "assignedTo": {
            "qualifier": "string",
            "userIds": [
              "60398b0231a295e64f084fd9"
            ]
          },
          "born": {
            "from": "Date",
            "to": "Date"
          }
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "templateIds": [
            "60398b0231a295e64f084fd9"
          ],
          "starts": {
            "from": "Date",
            "to": "Date"
          },
          "wasSelfScheduled": "boolean",
          "wasCancelled": "boolean",
          "wasNoShowed": "boolean",
          "wasRescheduled": "boolean"
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": { },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "formIds": [
            "60398b0231a295e64f084fd9"
          ],
          "formResponseCondition": [
            [
              { },
              { "key": string }
            ]
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      }
    ]
  ],
  "createdRange?": {
    "from": "Date",
    "to": "Date"
  },
  "updatedRange?": {
    "from": "Date",
    "to": "Date"
  }
}

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": "2023-05-29T20:17:34.984Z",
                "to": "2023-05-29T20:17:34.984Z"
              }
            }
          ],
          "Submitted Forms": {
            "qualifier": "string",
            "formIds": [
              "60398b0231a295e64f084fd9"
            ],
            "formResponseCondition": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          "assignedTo": {
            "qualifier": "string",
            "userIds": [
              "60398b0231a295e64f084fd9"
            ]
          },
          "born": {
            "from": "Date",
            "to": "Date"
          }
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "templateIds": [
            "60398b0231a295e64f084fd9"
          ],
          "starts": {
            "from": "Date",
            "to": "Date"
          },
          "wasSelfScheduled": "boolean",
          "wasCancelled": "boolean",
          "wasNoShowed": "boolean",
          "wasRescheduled": "boolean"
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": { },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {
          "formIds": [
            "60398b0231a295e64f084fd9"
          ],
          "formResponseCondition": [
            [
              { },
              { "key": string }
            ]
          ]
        },
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      },
      {
        "resource": "string",
        "filter": {},
        "info": [
          [
            {
              "method": "string",
              "parameters": { }
            }
          ]
        ],
        "grouping": {
          "Gender": "boolean",
          "Assigned To": "boolean",
          "Field": "string"
        },
        "range": {
          "interval": "string",
          "key": "string"
        }
      }
    ]
  ],
  "createdRange?": {
    "from": "Date",
    "to": "Date"
  },
  "updatedRange?": {
    "from": "Date",
    "to": "Date"
  },
  "parentFrame?": "string",
  "type?": "string"
}

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": "2023-05-29T20:17:34.984Z",
                    "to": "2023-05-29T20:17:34.984Z"
                  }
                }
              ],
              "Submitted Forms": {
                "qualifier": "string",
                "formIds": [
                  "60398b0231a295e64f084fd9"
                ],
                "formResponseCondition": [
                  [
                    { },
                    { "key": string }
                  ]
                ]
              },
              "assignedTo": {
                "qualifier": "string",
                "userIds": [
                  "60398b0231a295e64f084fd9"
                ]
              },
              "born": {
                "from": "Date",
                "to": "Date"
              }
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {
              "templateIds": [
                "60398b0231a295e64f084fd9"
              ],
              "starts": {
                "from": "Date",
                "to": "Date"
              },
              "wasSelfScheduled": "boolean",
              "wasCancelled": "boolean",
              "wasNoShowed": "boolean",
              "wasRescheduled": "boolean"
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": { },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {
              "formIds": [
                "60398b0231a295e64f084fd9"
              ],
              "formResponseCondition": [
                [
                  { },
                  { "key": string }
                ]
              ]
            },
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          },
          {
            "resource": "string",
            "filter": {},
            "info": [
              [
                {
                  "method": "string",
                  "parameters": { }
                }
              ]
            ],
            "grouping": {
              "Gender": "boolean",
              "Assigned To": "boolean",
              "Field": "string"
            },
            "range": {
              "interval": "string",
              "key": "string"
            }
          }
        ]
      ],
      "createdRange?": {
        "from": "Date",
        "to": "Date"
      },
      "updatedRange?": {
        "from": "Date",
        "to": "Date"
      },
      "parentFrame?": "string",
      "type?": "string"
    }
  ]
}

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": "2023-05-29T20:17:34.984Z",
                  "to": "2023-05-29T20:17:34.984Z"
                }
              }
            ],
            "Submitted Forms": {
              "qualifier": "string",
              "formIds": [
                "60398b0231a295e64f084fd9"
              ],
              "formResponseCondition": [
                [
                  { },
                  { "key": string }
                ]
              ]
            },
            "assignedTo": {
              "qualifier": "string",
              "userIds": [
                "60398b0231a295e64f084fd9"
              ]
            },
            "born": {
              "from": "Date",
              "to": "Date"
            }
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {
            "templateIds": [
              "60398b0231a295e64f084fd9"
            ],
            "starts": {
              "from": "Date",
              "to": "Date"
            },
            "wasSelfScheduled": "boolean",
            "wasCancelled": "boolean",
            "wasNoShowed": "boolean",
            "wasRescheduled": "boolean"
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": { },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {
            "formIds": [
              "60398b0231a295e64f084fd9"
            ],
            "formResponseCondition": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        },
        {
          "resource": "string",
          "filter": {},
          "info": [
            [
              {
                "method": "string",
                "parameters": { }
              }
            ]
          ],
          "grouping": {
            "Gender": "boolean",
            "Assigned To": "boolean",
            "Field": "string"
          },
          "range": {
            "interval": "string",
            "key": "string"
          }
        }
      ]
    ],
    "createdRange?": {
      "from": "Date",
      "to": "Date"
    },
    "updatedRange?": {
      "from": "Date",
      "to": "Date"
    },
    "parentFrame?": "string",
    "type?": "string"
  },
  "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"
}

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

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"
  },
  "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"
              }
            }
          ]
        }
      },
      {
        "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": {
          "senderId": "string",
          "formId": "string",
          "channel": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "assignmentStrategy": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ],
          "closeReasons": [
            "example string"
          ],
          "defaultAssignee": "string",
          "forCarePlan": "boolean",
          "hiddenFromTickets": "boolean",
          "htmlDescription": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "message": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "fields": [
            {
              "name": "example string",
              "type": "example string",
              "value": "example string"
            }
          ]
        }
      }
    ]
  ],
  "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"
                  }
                }
              ]
            }
          },
          {
            "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": {
              "senderId": "string",
              "formId": "string",
              "channel": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "assignmentStrategy": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ],
              "closeReasons": [
                "example string"
              ],
              "defaultAssignee": "string",
              "forCarePlan": "boolean",
              "hiddenFromTickets": "boolean",
              "htmlDescription": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "message": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "fields": [
                {
                  "name": "example string",
                  "type": "example string",
                  "value": "example string"
                }
              ]
            }
          }
        ]
      ],
      "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"
                }
              }
            ]
          }
        },
        {
          "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": {
            "senderId": "string",
            "formId": "string",
            "channel": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "assignmentStrategy": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ],
            "closeReasons": [
              "example string"
            ],
            "defaultAssignee": "string",
            "forCarePlan": "boolean",
            "hiddenFromTickets": "boolean",
            "htmlDescription": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "message": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "fields": [
              {
                "name": "example string",
                "type": "example string",
                "value": "example string"
              }
            ]
          }
        }
      ]
    ],
    "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": {
          "senderId": "string",
          "formId": "string",
          "channel": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "title": "string",
          "assignmentStrategy": [
            [
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              },
              {
                "type": "string",
                "info": {}
              }
            ]
          ],
          "closeReasons": [
            "example string"
          ],
          "defaultAssignee": "string",
          "forCarePlan": "boolean",
          "hiddenFromTickets": "boolean",
          "htmlDescription": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "message": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "fields": [
            {
              "name": "example string",
              "type": "example string",
              "value": "example string"
            }
          ]
        }
      }
    ]
  ],
  "conditions?": [
    {
      "type": "atJourneyState",
      "info": {
        "journeyId": "60398b0231a295e64f084fd9"
      }
    }
  ],
  "flowchartUI?": {
    "x": "number",
    "y": "number"
  },
  "continueOnError?": "boolean"
}

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": {
              "senderId": "string",
              "formId": "string",
              "channel": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "title": "string",
              "assignmentStrategy": [
                [
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  },
                  {
                    "type": "string",
                    "info": {}
                  }
                ]
              ],
              "closeReasons": [
                "example string"
              ],
              "defaultAssignee": "string",
              "forCarePlan": "boolean",
              "hiddenFromTickets": "boolean",
              "htmlDescription": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "message": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "fields": [
                {
                  "name": "example string",
                  "type": "example string",
                  "value": "example string"
                }
              ]
            }
          }
        ]
      ],
      "conditions?": [
        {
          "type": "atJourneyState",
          "info": {
            "journeyId": "60398b0231a295e64f084fd9"
          }
        }
      ],
      "flowchartUI?": {
        "x": "number",
        "y": "number"
      },
      "continueOnError?": "boolean"
    }
  ]
}

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": {
            "senderId": "string",
            "formId": "string",
            "channel": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "title": "string",
            "assignmentStrategy": [
              [
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                },
                {
                  "type": "string",
                  "info": {}
                }
              ]
            ],
            "closeReasons": [
              "example string"
            ],
            "defaultAssignee": "string",
            "forCarePlan": "boolean",
            "hiddenFromTickets": "boolean",
            "htmlDescription": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "message": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "fields": [
              {
                "name": "example string",
                "type": "example string",
                "value": "example string"
              }
            ]
          }
        }
      ]
    ],
    "conditions?": [
      {
        "type": "atJourneyState",
        "info": {
          "journeyId": "60398b0231a295e64f084fd9"
        }
      }
    ],
    "flowchartUI?": {
      "x": "number",
      "y": "number"
    },
    "continueOnError?": "boolean"
  },
  "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"
    }
  ]
}

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"
        },
        "conditions": [
          [
            { },
            { "key": string }
          ]
        ]
      },
      {
        "type": "string",
        "info": {
          "formId": "string",
          "intervalInMS": "number"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "field": "string",
          "value": "string"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "intervalInMS": "number"
        },
        "conditions": { }
      },
      {
        "type": "string",
        "info": { },
        "conditions": { }
      },
      {
        "type": "string",
        "info": { },
        "conditions": { }
      },
      {
        "type": "string",
        "info": { },
        "conditions": { }
      },
      {
        "type": "string",
        "info": {
          "titles": [
            "example string"
          ]
        },
        "conditions": { }
      }
    ]
  ],
  "action": [
    [
      {
        "type": "string",
        "info": {
          "journeyId": "string"
        }
      },
      {
        "type": "string",
        "info": { }
      },
      {
        "type": "string",
        "info": {
          "tags": [
            "example string"
          ]
        }
      }
    ]
  ],
  "status": "string",
  "enduserCondition?": [
    [
      { },
      { "key": string }
    ]
  ],
  "journeyId?": "string"
}

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"
            },
            "conditions": [
              [
                { },
                { "key": string }
              ]
            ]
          },
          {
            "type": "string",
            "info": {
              "formId": "string",
              "intervalInMS": "number"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "field": "string",
              "value": "string"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "intervalInMS": "number"
            },
            "conditions": { }
          },
          {
            "type": "string",
            "info": { },
            "conditions": { }
          },
          {
            "type": "string",
            "info": { },
            "conditions": { }
          },
          {
            "type": "string",
            "info": { },
            "conditions": { }
          },
          {
            "type": "string",
            "info": {
              "titles": [
                "example string"
              ]
            },
            "conditions": { }
          }
        ]
      ],
      "action": [
        [
          {
            "type": "string",
            "info": {
              "journeyId": "string"
            }
          },
          {
            "type": "string",
            "info": { }
          },
          {
            "type": "string",
            "info": {
              "tags": [
                "example string"
              ]
            }
          }
        ]
      ],
      "status": "string",
      "enduserCondition?": [
        [
          { },
          { "key": string }
        ]
      ],
      "journeyId?": "string"
    }
  ]
}

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"
          },
          "conditions": [
            [
              { },
              { "key": string }
            ]
          ]
        },
        {
          "type": "string",
          "info": {
            "formId": "string",
            "intervalInMS": "number"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "field": "string",
            "value": "string"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "intervalInMS": "number"
          },
          "conditions": { }
        },
        {
          "type": "string",
          "info": { },
          "conditions": { }
        },
        {
          "type": "string",
          "info": { },
          "conditions": { }
        },
        {
          "type": "string",
          "info": { },
          "conditions": { }
        },
        {
          "type": "string",
          "info": {
            "titles": [
              "example string"
            ]
          },
          "conditions": { }
        }
      ]
    ],
    "action?": [
      [
        {
          "type": "string",
          "info": {
            "journeyId": "string"
          }
        },
        {
          "type": "string",
          "info": { }
        },
        {
          "type": "string",
          "info": {
            "tags": [
              "example string"
            ]
          }
        }
      ]
    ],
    "status?": "string",
    "enduserCondition?": [
      [
        { },
        { "key": string }
      ]
    ],
    "journeyId?": "string"
  },
  "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",
  "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"
}

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

{
  "calendarEventTemplateId": "string",
  "from": "Date",
  "locationId?": "string",
  "restrictedByState?": "boolean",
  "to?": "Date",
  "limit?": "number",
  "businessId?": "string",
  "userId?": "string",
  "userIds?": [
    "60398b0231a295e64f084fd9"
  ]
}

Book Appointment

Method: POST

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

Books an appointment with a given user if available

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

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

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

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

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

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

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

Constraints

  • All of [enduserId, title] must be unique for each 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"
  ]
}

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

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"
    ]
  },
  "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",
  "message": "string",
  "html?": "string",
  "replyId?": "string",
  "readBy?": { string: Date },
  "attachments?": [
    {
      "secureName": "example string"
    }
  ],
  "templateId?": "string",
  "automationStepId?": "string",
  "linkOpenTrackingIds?": [
    "example string"
  ]
}

Update Chat

Method: PATCH

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

Updates Chat fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "senderId?": "string",
    "message?": "string",
    "html?": "string",
    "readBy?": { string: Date },
    "attachments?": [
      {
        "secureName": "example string"
      }
    ],
    "templateId?": "string",
    "automationStepId?": "string",
    "linkOpenTrackingIds?": [
      "example 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"
}

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

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

DatabaseRecords

Create DatabaseRecord

Method: POST

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

Creates a new DatabaseRecord

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "databaseId": "string",
  "values": [
    {
      "type": "string",
      "value": "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": "string",
          "value": "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": "string",
        "value": "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": "string-long",
      "label": "example string"
    }
  ]
}

Create Databases

Method: POST

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

Creates new Databases

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "fields": [
        {
          "type": "string-long",
          "label": "example string"
        }
      ]
    }
  ]
}

Update Database

Method: PATCH

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

Updates Database fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "fields?": [
      {
        "type": "string-long",
        "label": "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"
}

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 },
  "templateId?": "string",
  "automationStepId?": "string",
  "linkOpenTrackingIds?": [
    "example string"
  ],
  "journeyContext?": {
    "calendarEventId": "string"
  },
  "sendAt?": "Date",
  "pinnedAt?": "Date"
}

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 },
      "templateId?": "string",
      "automationStepId?": "string",
      "linkOpenTrackingIds?": [
        "example string"
      ],
      "journeyContext?": {
        "calendarEventId": "string"
      },
      "sendAt?": "Date",
      "pinnedAt?": "Date"
    }
  ]
}

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 },
    "templateId?": "string",
    "automationStepId?": "string",
    "linkOpenTrackingIds?": [
      "example string"
    ],
    "journeyContext?": {
      "calendarEventId": "string"
    },
    "sendAt?": "Date",
    "pinnedAt?": "Date"
  },
  "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

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

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

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

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

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",
  "journeyContext?": {
    "calendarEventId": "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

Authentication info only

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

Create Enduser

Method: POST

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

Creates a new Enduser

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "externalId?": "string",
  "email?": "string",
  "emailConsent?": "boolean",
  "phone?": "string",
  "landline?": "string",
  "phoneConsent?": "boolean",
  "fname?": "string",
  "lname?": "string",
  "dateOfBirth?": "string",
  "journeys?": {
    "string": "string"
  },
  "scheduledJourneys?": [
    {
      "journeyId": "60398b0231a295e64f084fd9",
      "addAt": "2023-05-29T20:17:34.961Z"
    }
  ],
  "tags?": [
    "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 }
}

Create Endusers

Method: POST

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

Creates new Endusers

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "externalId?": "string",
      "email?": "string",
      "emailConsent?": "boolean",
      "phone?": "string",
      "landline?": "string",
      "phoneConsent?": "boolean",
      "fname?": "string",
      "lname?": "string",
      "dateOfBirth?": "string",
      "journeys?": {
        "string": "string"
      },
      "scheduledJourneys?": [
        {
          "journeyId": "60398b0231a295e64f084fd9",
          "addAt": "2023-05-29T20:17:34.961Z"
        }
      ],
      "tags?": [
        "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 }
    }
  ]
}

Update Enduser

Method: PATCH

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

Updates Enduser fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "externalId?": "string",
    "email?": "string",
    "emailConsent?": "boolean",
    "phone?": "string",
    "landline?": "string",
    "phoneConsent?": "boolean",
    "fname?": "string",
    "lname?": "string",
    "dateOfBirth?": "string",
    "journeys?": {
      "string": "string"
    },
    "scheduledJourneys?": [
      {
        "journeyId": "60398b0231a295e64f084fd9",
        "addAt": "2023-05-29T20:17:34.961Z"
      }
    ],
    "tags?": [
      "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 }
  },
  "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 },
  "hideProfileLink?": "boolean"
}

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 },
      "hideProfileLink?": "boolean"
    }
  ]
}

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 },
    "hideProfileLink?": "boolean"
  },
  "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",
  "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"
}

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

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",
  "type?": "string",
  "previousFields?": [
    {
      "type": "root",
      "info": {}
    }
  ],
  "flowchartUI?": {
    "x": "number",
    "y": "number"
  },
  "options?": {
    "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"
    ],
    "signatureUrl": "string",
    "maxLength": "number",
    "minLength": "number",
    "repeat": "boolean"
  },
  "description?": "string",
  "htmlDescription?": "string",
  "intakeField?": "string",
  "isOptional?": "boolean",
  "isInGroup?": "boolean",
  "sharedWithEnduser?": "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",
      "type?": "string",
      "previousFields?": [
        {
          "type": "root",
          "info": {}
        }
      ],
      "flowchartUI?": {
        "x": "number",
        "y": "number"
      },
      "options?": {
        "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"
        ],
        "signatureUrl": "string",
        "maxLength": "number",
        "minLength": "number",
        "repeat": "boolean"
      },
      "description?": "string",
      "htmlDescription?": "string",
      "intakeField?": "string",
      "isOptional?": "boolean",
      "isInGroup?": "boolean",
      "sharedWithEnduser?": "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",
    "type?": "string",
    "previousFields?": [
      {
        "type": "root",
        "info": {}
      }
    ],
    "flowchartUI?": {
      "x": "number",
      "y": "number"
    },
    "options?": {
      "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"
      ],
      "signatureUrl": "string",
      "maxLength": "number",
      "minLength": "number",
      "repeat": "boolean"
    },
    "description?": "string",
    "htmlDescription?": "string",
    "intakeField?": "string",
    "isOptional?": "boolean",
    "isInGroup?": "boolean",
    "sharedWithEnduser?": "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"
}

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

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": "60398b0231a295e64f084fd9",
      "fieldTitle": "example string",
      "fieldDescription": "example string",
      "fieldHtmlDescription": "example string",
      "answer": {
        "type": "Question Group",
        "value": [
          {
            "id": "60398b0231a295e64f084fd9"
          }
        ]
      },
      "externalId": "example string",
      "sharedWithEnduser": true
    }
  ],
  "automationStepId?": "string",
  "customerId?": "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"
}

Create FormResponse

Method: POST

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

Creates a new FormResponse

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "formId": "string",
  "enduserId?": "string",
  "submissionExpiresAt?": "number",
  "openedAt?": "Date",
  "publicSubmit?": "boolean",
  "submittedBy?": "string",
  "accessCode?": "string",
  "userEmail?": "string",
  "submittedAt?": "Date",
  "formTitle?": "string",
  "responses?": [
    {
      "fieldId": "60398b0231a295e64f084fd9",
      "fieldTitle": "example string",
      "fieldDescription": "example string",
      "fieldHtmlDescription": "example string",
      "answer": {
        "type": "Question Group",
        "value": [
          {
            "id": "60398b0231a295e64f084fd9"
          }
        ]
      },
      "externalId": "example string",
      "sharedWithEnduser": true
    }
  ],
  "draftSavedAt?": "Date",
  "hideFromEnduserPortal?": "boolean",
  "sharedVia?": "string",
  "isInternalNote?": "boolean",
  "pinnedAt?": "Date"
}

Create FormResponses

Method: POST

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

Creates new FormResponses

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "formId": "string",
      "enduserId?": "string",
      "submissionExpiresAt?": "number",
      "openedAt?": "Date",
      "publicSubmit?": "boolean",
      "submittedBy?": "string",
      "accessCode?": "string",
      "userEmail?": "string",
      "submittedAt?": "Date",
      "formTitle?": "string",
      "responses?": [
        {
          "fieldId": "60398b0231a295e64f084fd9",
          "fieldTitle": "example string",
          "fieldDescription": "example string",
          "fieldHtmlDescription": "example string",
          "answer": {
            "type": "Question Group",
            "value": [
              {
                "id": "60398b0231a295e64f084fd9"
              }
            ]
          },
          "externalId": "example string",
          "sharedWithEnduser": true
        }
      ],
      "draftSavedAt?": "Date",
      "hideFromEnduserPortal?": "boolean",
      "sharedVia?": "string",
      "isInternalNote?": "boolean",
      "pinnedAt?": "Date"
    }
  ]
}

Update FormResponse

Method: PATCH

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

Updates FormResponse fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "formId?": "string",
    "enduserId?": "string",
    "openedAt?": "Date",
    "publicSubmit?": "boolean",
    "submittedBy?": "string",
    "accessCode?": "string",
    "userEmail?": "string",
    "submittedAt?": "Date",
    "formTitle?": "string",
    "responses?": [
      {
        "fieldId": "60398b0231a295e64f084fd9",
        "fieldTitle": "example string",
        "fieldDescription": "example string",
        "fieldHtmlDescription": "example string",
        "answer": {
          "type": "Question Group",
          "value": [
            {
              "id": "60398b0231a295e64f084fd9"
            }
          ]
        },
        "externalId": "example string",
        "sharedWithEnduser": true
      }
    ],
    "draftSavedAt?": "Date",
    "hideFromEnduserPortal?": "boolean",
    "sharedVia?": "string",
    "isInternalNote?": "boolean",
    "pinnedAt?": "Date"
  },
  "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"
}

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",
  "thanksMessage?": "string",
  "htmlThanksMessage?": "string",
  "type?": "string",
  "scoring?": [
    {
      "fieldId": "60398b0231a295e64f084fd9",
      "response": "example string",
      "score": "example string"
    }
  ],
  "productIds?": [
    "60398b0231a295e64f084fd9"
  ]
}

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",
      "thanksMessage?": "string",
      "htmlThanksMessage?": "string",
      "type?": "string",
      "scoring?": [
        {
          "fieldId": "60398b0231a295e64f084fd9",
          "response": "example string",
          "score": "example string"
        }
      ],
      "productIds?": [
        "60398b0231a295e64f084fd9"
      ]
    }
  ]
}

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",
    "thanksMessage?": "string",
    "htmlThanksMessage?": "string",
    "type?": "string",
    "scoring?": [
      {
        "fieldId": "60398b0231a295e64f084fd9",
        "response": "example string",
        "score": "example string"
      }
    ],
    "productIds?": [
      "60398b0231a295e64f084fd9"
    ]
  },
  "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?": [
    {
      "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?": [
        {
          "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?": [
      {
        "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

Integrations

Constraints

  • All of [title, creator] must be unique for each Integrations

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

Authentication info only

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

Add an API-Key based integration

Method: POST

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

{
  "API_KEY": "string",
  "integration": "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

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",
  "calendars?": [
    "example 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",
      "calendars?": [
        "example 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",
    "calendars?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}