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.

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

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",
          "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"
        }
      }
    ]
  ],
  "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": {}
              }
            ]
          ],
          "closeReasons": [
            "example string"
          ],
          "defaultAssignee": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "message": "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",
              "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"
            }
          }
        ]
      ],
      "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": {}
                  }
                ]
              ],
              "closeReasons": [
                "example string"
              ],
              "defaultAssignee": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "message": "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",
            "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"
          }
        }
      ]
    ],
    "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": {}
                }
              ]
            ],
            "closeReasons": [
              "example string"
            ],
            "defaultAssignee": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "message": "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": {}
              }
            ]
          ],
          "closeReasons": [
            "example string"
          ],
          "defaultAssignee": "string"
        }
      },
      {
        "type": "string",
        "info": {
          "message": "string"
        }
      }
    ]
  ],
  "conditions?": [
    {
      "type": "atJourneyState",
      "info": {
        "journeyId": "60398b0231a295e64f084fd9"
      }
    }
  ],
  "flowchartUI?": {
    "x": "number",
    "y": "number"
  }
}

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": {}
                  }
                ]
              ],
              "closeReasons": [
                "example string"
              ],
              "defaultAssignee": "string"
            }
          },
          {
            "type": "string",
            "info": {
              "message": "string"
            }
          }
        ]
      ],
      "conditions?": [
        {
          "type": "atJourneyState",
          "info": {
            "journeyId": "60398b0231a295e64f084fd9"
          }
        }
      ],
      "flowchartUI?": {
        "x": "number",
        "y": "number"
      }
    }
  ]
}

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": {}
                }
              ]
            ],
            "closeReasons": [
              "example string"
            ],
            "defaultAssignee": "string"
          }
        },
        {
          "type": "string",
          "info": {
            "message": "string"
          }
        }
      ]
    ],
    "conditions?": [
      {
        "type": "atJourneyState",
        "info": {
          "journeyId": "60398b0231a295e64f084fd9"
        }
      }
    ],
    "flowchartUI?": {
      "x": "number",
      "y": "number"
    }
  },
  "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

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

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",
  "restrictedByState?": "boolean",
  "to?": "Date",
  "limit?": "number"
}

Book Appointment

Method: POST

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

Books an appointment with a given user if available

{
  "calendarEventTemplateId": "string",
  "userId": "string",
  "startTime": "Date"
}

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",
  "description?": "string",
  "meetingStatus?": "string",
  "attachments?": [
    {
      "displayName": "example string",
      "fileId": "60398b0231a295e64f084fd9",
      "secureName": "example string"
    }
  ],
  "chatRoomId?": "string",
  "carePlanId?": "string",
  "attendees?": [
    {
      "type": "user",
      "id": "60398b0231a295e64f084fd9"
    }
  ],
  "reminders?": [
    {
      "info": {},
      "type": "webhook",
      "msBeforeStartTime": 0,
      "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"
    }
  ],
  "location?": "string",
  "locationURL?": "string",
  "locationNotes?": "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",
      "description?": "string",
      "meetingStatus?": "string",
      "attachments?": [
        {
          "displayName": "example string",
          "fileId": "60398b0231a295e64f084fd9",
          "secureName": "example string"
        }
      ],
      "chatRoomId?": "string",
      "carePlanId?": "string",
      "attendees?": [
        {
          "type": "user",
          "id": "60398b0231a295e64f084fd9"
        }
      ],
      "reminders?": [
        {
          "info": {},
          "type": "webhook",
          "msBeforeStartTime": 0,
          "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"
        }
      ],
      "location?": "string",
      "locationURL?": "string",
      "locationNotes?": "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",
    "description?": "string",
    "meetingStatus?": "string",
    "attachments?": [
      {
        "displayName": "example string",
        "fileId": "60398b0231a295e64f084fd9",
        "secureName": "example string"
      }
    ],
    "chatRoomId?": "string",
    "carePlanId?": "string",
    "attendees?": [
      {
        "type": "user",
        "id": "60398b0231a295e64f084fd9"
      }
    ],
    "reminders?": [
      {
        "info": {},
        "type": "webhook",
        "msBeforeStartTime": 0,
        "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"
      }
    ],
    "location?": "string",
    "locationURL?": "string",
    "locationNotes?": "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",
  "description?": "string",
  "reminders?": [
    {
      "info": {},
      "type": "webhook",
      "msBeforeStartTime": 0,
      "didRemind": true
    }
  ],
  "publicRead?": "boolean",
  "enableVideoCall?": "boolean",
  "enableSelfScheduling?": "boolean",
  "restrictedByState?": "boolean",
  "image?": "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",
      "description?": "string",
      "reminders?": [
        {
          "info": {},
          "type": "webhook",
          "msBeforeStartTime": 0,
          "didRemind": true
        }
      ],
      "publicRead?": "boolean",
      "enableVideoCall?": "boolean",
      "enableSelfScheduling?": "boolean",
      "restrictedByState?": "boolean",
      "image?": "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",
    "description?": "string",
    "reminders?": [
      {
        "info": {},
        "type": "webhook",
        "msBeforeStartTime": 0,
        "didRemind": true
      }
    ],
    "publicRead?": "boolean",
    "enableVideoCall?": "boolean",
    "enableSelfScheduling?": "boolean",
    "restrictedByState?": "boolean",
    "image?": "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",
  "message": "string",
  "html?": "string",
  "replyId?": "string",
  "readBy?": { string: Date },
  "attachments?": [
    {
      "type": "image",
      "secureName": "example string"
    }
  ],
  "templateId?": "string",
  "automationStepId?": "string",
  "linkOpenTrackingIds?": [
    "example string"
  ]
}

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

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

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

Attendee display info

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

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

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

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

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

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
  • One of email or phone is required
  • 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"
  ]
}

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

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

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",
  "phoneConsent?": "boolean",
  "fname?": "string",
  "lname?": "string",
  "dateOfBirth?": "string",
  "journeys?": {
    "string": "string"
  },
  "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",
  "state?": "string",
  "timezone?": "string",
  "gender?": "string",
  "height?": {
    "value": "string",
    "unit": "string"
  },
  "weight?": {
    "value": "string",
    "unit": "string"
  },
  "zipCode?": "string",
  "source?": "string"
}

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",
      "phoneConsent?": "boolean",
      "fname?": "string",
      "lname?": "string",
      "dateOfBirth?": "string",
      "journeys?": {
        "string": "string"
      },
      "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",
      "state?": "string",
      "timezone?": "string",
      "gender?": "string",
      "height?": {
        "value": "string",
        "unit": "string"
      },
      "weight?": {
        "value": "string",
        "unit": "string"
      },
      "zipCode?": "string",
      "source?": "string"
    }
  ]
}

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",
    "phoneConsent?": "boolean",
    "fname?": "string",
    "lname?": "string",
    "dateOfBirth?": "string",
    "journeys?": {
      "string": "string"
    },
    "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",
    "state?": "string",
    "timezone?": "string",
    "gender?": "string",
    "height?": {
      "value": "string",
      "unit": "string"
    },
    "weight?": {
      "value": "string",
      "unit": "string"
    },
    "zipCode?": "string",
    "source?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Enduser

Method: GET

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

Get an Enduser

{
  "filter?": {}
}

Get Endusers

Method: GET

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

Get a page of Endusers

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

Delete Enduser

Method: DELETE

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

Delete one Enduser

Authentication info only

EnduserStatusUpdates

Create EnduserStatusUpdate

Method: POST

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

Creates a new EnduserStatusUpdate

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

Create EnduserStatusUpdates

Method: POST

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

Creates new EnduserStatusUpdates

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

Get EnduserStatusUpdate

Method: GET

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

Get an EnduserStatusUpdate

{
  "filter?": {}
}

Get EnduserStatusUpdates

Method: GET

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

Get a page of EnduserStatusUpdates

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

Delete EnduserStatusUpdate

Method: DELETE

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

Delete one EnduserStatusUpdate

Authentication info only

EnduserTasks

Constraints

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

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"
  },
  "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?": {
    "choices": [
      "example string"
    ],
    "from": "number",
    "to": "number",
    "other": "boolean",
    "radio": "boolean",
    "pdfAttachment": "string"
  },
  "description?": "string",
  "intakeField?": "string",
  "isOptional?": "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?": {
        "choices": [
          "example string"
        ],
        "from": "number",
        "to": "number",
        "other": "boolean",
        "radio": "boolean",
        "pdfAttachment": "string"
      },
      "description?": "string",
      "intakeField?": "string",
      "isOptional?": "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?": {
      "choices": [
        "example string"
      ],
      "from": "number",
      "to": "number",
      "other": "boolean",
      "radio": "boolean",
      "pdfAttachment": "string"
    },
    "description?": "string",
    "intakeField?": "string",
    "isOptional?": "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.

{
  "email": "string",
  "formId": "string",
  "businessId": "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"
}

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",
      "answer": {
        "type": "email",
        "value": "example@tellescope.com"
      }
    }
  ],
  "automationStepId?": "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"
}

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",
      "answer": {
        "type": "email",
        "value": "example@tellescope.com"
      }
    }
  ],
  "draftSavedAt?": "Date",
  "hideFromEnduserPortal?": "boolean"
}

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",
          "answer": {
            "type": "email",
            "value": "example@tellescope.com"
          }
        }
      ],
      "draftSavedAt?": "Date",
      "hideFromEnduserPortal?": "boolean"
    }
  ]
}

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",
        "answer": {
          "type": "email",
          "value": "example@tellescope.com"
        }
      }
    ],
    "draftSavedAt?": "Date",
    "hideFromEnduserPortal?": "boolean"
  },
  "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

Create Form

Method: POST

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

Creates a new Form

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "title": "string",
  "numFields?": "number",
  "description?": "string",
  "customGreeting?": "string",
  "customSignature?": "string",
  "customSubject?": "string",
  "allowPublicURL?": "boolean",
  "intakePhone?": "string",
  "thanksMessage?": "string",
  "type?": "string"
}

Create Forms

Method: POST

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

Creates new Forms

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "title": "string",
      "numFields?": "number",
      "description?": "string",
      "customGreeting?": "string",
      "customSignature?": "string",
      "customSubject?": "string",
      "allowPublicURL?": "boolean",
      "intakePhone?": "string",
      "thanksMessage?": "string",
      "type?": "string"
    }
  ]
}

Update Form

Method: PATCH

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

Updates Form fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "title?": "string",
    "numFields?": "number",
    "description?": "string",
    "customGreeting?": "string",
    "customSignature?": "string",
    "customSubject?": "string",
    "allowPublicURL?": "boolean",
    "intakePhone?": "string",
    "thanksMessage?": "string",
    "type?": "string"
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Form

Method: GET

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

Get an Form

{
  "filter?": {}
}

Get Forms

Method: GET

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

Get a page of Forms

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

Delete Form

Method: DELETE

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

Delete one Form

Authentication info only

ForumPosts

Create ForumPost

Method: POST

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

Creates a new ForumPost

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "forumId": "string",
  "postedBy?": {
    "type": "string",
    "id": "string"
  },
  "numComments?": "number",
  "numLikes?": "number",
  "title": "string",
  "textContent": "string",
  "htmlContent?": "string",
  "editorState?": "string",
  "slug?": "string",
  "attachments?": [
    {
      "type": "image",
      "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?": [
        {
          "type": "image",
          "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?": [
      {
        "type": "image",
        "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

Disconnects an integration with Google

Method: POST

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

Authentication info only

Uses a refresh_token to refresh a session and return the result

Method: POST

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

{}

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

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

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

Get Integration

Method: GET

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

Get an Integration

{
  "filter?": {}
}

Get Integrations

Method: GET

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

Get a page of Integrations

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

Delete Integration

Method: DELETE

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

Delete one Integration

Authentication info only

Journeys

Constraints

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

Delete States

Method: DELETE

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

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

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

Create Journey

Method: POST

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

Creates a new Journey

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

Create Journeys

Method: POST

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

Creates new Journeys

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

Update Journey

Method: PATCH

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

Updates Journey fields

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

Get Journey

Method: GET

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

Get an Journey

{
  "filter?": {}
}

Get Journeys

Method: GET

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

Get a page of Journeys

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

Delete Journey

Method: DELETE

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

Delete one Journey

Authentication info only

ManagedContentRecordAssignments

Constraints

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

Create ManagedContentRecordAssignment

Method: POST

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

Creates a new ManagedContentRecordAssignment

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

Create ManagedContentRecordAssignments

Method: POST

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

Creates new ManagedContentRecordAssignments

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

Update ManagedContentRecordAssignment

Method: PATCH

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

Updates ManagedContentRecordAssignment fields

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

Get ManagedContentRecordAssignment

Method: GET

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

Get an ManagedContentRecordAssignment

{
  "filter?": {}
}

Get ManagedContentRecordAssignments

Method: GET

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

Get a page of ManagedContentRecordAssignments

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

Delete ManagedContentRecordAssignment

Method: DELETE

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

Delete one ManagedContentRecordAssignment

Authentication info only

ManagedContentRecords

Create ManagedContentRecord

Method: POST

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

Creates a new ManagedContentRecord

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

Create ManagedContentRecords

Method: POST

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

Creates new ManagedContentRecords

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

Update ManagedContentRecord

Method: PATCH

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

Updates ManagedContentRecord fields

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

Get ManagedContentRecord

Method: GET

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

Get an ManagedContentRecord

{
  "filter?": {}
}

Get ManagedContentRecords

Method: GET

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

Get a page of ManagedContentRecords

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

Delete ManagedContentRecord

Method: DELETE

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

Delete one ManagedContentRecord

Authentication info only

Meetings

Get Meeting

Method: GET

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

Get a meeting

{
  "id?": "string"
}

Start Meeting

Method: POST

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

Generates an video meeting room

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

Send Meeting Invite

Method: POST

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

Sends a meeting invite via email to the given enduser

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

End Meeting

Method: POST

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

Ends a video meeting

{
  "id": "string"
}

Add Attendees to Meeting

Method: POST

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

Adds other attendees to a meeting

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

Get attendee info for meeting

Method: GET

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

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

{
  "id": "string"
}

Get list of meetings

Method: GET

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

Gets meetings for the current user.

Authentication info only

Start Scheduled Meeting

Method: POST

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

Generates an video meeting room

{
  "calendarEventId": "string"
}

Join Scheduled Meeting

Method: POST

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

Generates an video meeting room

{
  "calendarEventId": "string"
}

Get Meetings (Admin Only)

Method: GET

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

Get a page of Meetings

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

Notes

Create Note

Method: POST

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

Creates a new Note

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

Create Notes

Method: POST

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

Creates new Notes

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

Update Note

Method: PATCH

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

Updates Note fields

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

Get Note

Method: GET

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

Get an Note

{
  "filter?": {}
}

Get Notes

Method: GET

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

Get a page of Notes

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

Delete Note

Method: DELETE

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

Delete one Note

Authentication info only

Organizations

Get Organization Theme (Public)

Method: GET

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

Gets theme information for an organization

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

Create Sub Organization (Admin Only)

Method: POST

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

Creates a sub organization

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

Invite User (Admin Only)

Method: POST

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

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

{
  "email": "string",
  "fname": "string",
  "lname": "string",
  "organizationId": "string"
}

Get Organization

Method: GET

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

Get an Organization

{
  "filter?": {}
}

Get Organizations

Method: GET

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

Get a page of Organizations

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

Update Organization (Admin Only)

Method: PATCH

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

Updates Organization fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "subdomain?": "string",
    "parentOrganizationId?": "string",
    "subscriptionExpiresAt?": "Date",
    "subscriptionPeriod?": "number",
    "logoVersion?": "number",
    "faviconVersion?": "number",
    "roles?": [
      "example string"
    ],
    "skills?": [
      "example string"
    ],
    "customPortalURL?": "string",
    "portalSettings?": {
      "authentication": {
        "landingTitle": "string",
        "landingGraphic": "string",
        "landingLogo": "string",
        "loginDescription": "string",
        "loginGraphic": "string",
        "loginTitle": "string",
        "registerDescription": "string",
        "registerGraphic": "string",
        "registerTitle": "string"
      }
    },
    "settings?": {
      "endusers": {
        "disableMultipleChatRooms": "boolean",
        "customFields": [
          {
            "type": "Select",
            "info": {
              "options": [
                "example string"
              ]
            },
            "field": "example string",
            "required": true
          }
        ]
      }
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

PortalCustomizations

Constraints

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

Create PortalCustomization

Method: POST

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

Creates a new PortalCustomization

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

Create PortalCustomizations

Method: POST

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

Creates new PortalCustomizations

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

Update PortalCustomization

Method: PATCH

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

Updates PortalCustomization fields

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

Get PortalCustomization

Method: GET

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

Get an PortalCustomization

{
  "filter?": {}
}

Get PortalCustomizations

Method: GET

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

Get a page of PortalCustomizations

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

Delete PortalCustomization

Method: DELETE

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

Delete one PortalCustomization

Authentication info only

PostComments

Create PostComment

Method: POST

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

Creates a new PostComment

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

Create PostComments

Method: POST

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

Creates new PostComments

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

Update PostComment

Method: PATCH

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

Updates PostComment fields

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

Get PostComment

Method: GET

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

Get an PostComment

{
  "filter?": {}
}

Get PostComments

Method: GET

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

Get a page of PostComments

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

Delete PostComment

Method: DELETE

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

Delete one PostComment

Authentication info only

PostLikes

Like Forum Post

Method: POST

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

Likes a post

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

Unlike Forum Post

Method: POST

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

Removes a like for a given forum post

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

Get PostLike

Method: GET

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

Get an PostLike

{
  "filter?": {}
}

Get PostLikes

Method: GET

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

Get a page of PostLikes

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

Delete PostLike

Method: DELETE

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

Delete one PostLike

Authentication info only

RoleBasedAccessPermissions

Constraints

  • role must be unique across RoleBasedAccessPermissions

Get RoleBasedAccessPermission

Method: GET

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

Get an RoleBasedAccessPermission

{
  "filter?": {}
}

Get RoleBasedAccessPermissions

Method: GET

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

Get a page of RoleBasedAccessPermissions

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

Create RoleBasedAccessPermission

Method: POST

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

Creates a new RoleBasedAccessPermission

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "role": "string",
  "permissions": {
    "endusers": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_status_updates": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "engagement_events": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "journeys": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "api_keys": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "tasks": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "emails": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "sms_messages": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "chat_rooms": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "chats": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "users": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "templates": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "files": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "tickets": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "meetings": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "notes": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "forms": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "form_fields": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "form_responses": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "calendar_events": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "calendar_event_templates": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "calendar_event_RSVPs": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "automation_steps": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "automated_actions": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "webhooks": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "user_logs": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "user_notifications": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_observations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "managed_content_records": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "managed_content_record_assignments": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "forums": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "forum_posts": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "post_likes": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "comment_likes": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "post_comments": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "organizations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "integrations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "databases": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "database_records": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "portal_customizations": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "care_plans": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "enduser_tasks": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "role_based_access_permissions": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    },
    "apiKeys": {
      "create": "string",
      "delete": "string",
      "read": "string",
      "update": "string",
      "showInSidebar": "boolean"
    }
  }
}

Create RoleBasedAccessPermissions

Method: POST

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

Creates new RoleBasedAccessPermissions

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "role": "string",
      "permissions": {
        "endusers": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_status_updates": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "engagement_events": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "journeys": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "api_keys": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "tasks": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "emails": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "sms_messages": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "chat_rooms": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "chats": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "users": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "templates": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "files": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "tickets": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "meetings": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "notes": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "forms": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "form_fields": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "form_responses": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "calendar_events": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "calendar_event_templates": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "calendar_event_RSVPs": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "automation_steps": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "automated_actions": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "webhooks": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "user_logs": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "user_notifications": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_observations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "managed_content_records": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "managed_content_record_assignments": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "forums": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "forum_posts": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "post_likes": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "comment_likes": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "post_comments": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "organizations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "integrations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "databases": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "database_records": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "portal_customizations": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "care_plans": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "enduser_tasks": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "role_based_access_permissions": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        },
        "apiKeys": {
          "create": "string",
          "delete": "string",
          "read": "string",
          "update": "string",
          "showInSidebar": "boolean"
        }
      }
    }
  ]
}

Update RoleBasedAccessPermission

Method: PATCH

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

Updates RoleBasedAccessPermission fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "role?": "string",
    "permissions?": {
      "endusers": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_status_updates": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "engagement_events": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "journeys": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "api_keys": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "tasks": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "emails": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "sms_messages": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "chat_rooms": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "chats": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "users": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "templates": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "files": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "tickets": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "meetings": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "notes": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "forms": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "form_fields": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "form_responses": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "calendar_events": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "calendar_event_templates": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "calendar_event_RSVPs": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "automation_steps": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "automated_actions": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "webhooks": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "user_logs": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "user_notifications": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_observations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "managed_content_records": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "managed_content_record_assignments": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "forums": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "forum_posts": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "post_likes": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "comment_likes": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "post_comments": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "organizations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "integrations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "databases": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "database_records": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "portal_customizations": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "care_plans": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "enduser_tasks": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "role_based_access_permissions": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      },
      "apiKeys": {
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
        "showInSidebar": "boolean"
      }
    }
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Delete RoleBasedAccessPermission

Method: DELETE

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

Delete one RoleBasedAccessPermission

Authentication info only

SmsMessages

Constraints

  • Phone number and phone consent must be set for enduser

Create SmsMessage

Method: POST

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

Sends or logs an SMS message

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "logOnly?": "boolean",
  "message": "string",
  "enduserId": "string",
  "userId?": "string",
  "inbound?": "boolean",
  "newThread?": "boolean",
  "readBy?": { string: Date },
  "templateId?": "string",
  "automationStepId?": "string",
  "linkOpenTrackingIds?": [
    "example string"
  ]
}

Create SmsMessages

Method: POST

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

Sends or logs multiple SMS message

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "logOnly?": "boolean",
      "message": "string",
      "enduserId": "string",
      "userId?": "string",
      "inbound?": "boolean",
      "newThread?": "boolean",
      "readBy?": { string: Date },
      "templateId?": "string",
      "automationStepId?": "string",
      "linkOpenTrackingIds?": [
        "example string"
      ]
    }
  ]
}

Update SmsMessage

Method: PATCH

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

Updates SmsMessage fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "logOnly?": "boolean",
    "inbound?": "boolean",
    "readBy?": { string: Date },
    "templateId?": "string",
    "automationStepId?": "string",
    "linkOpenTrackingIds?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get SmsMessage

Method: GET

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

Get an SmsMessage

{
  "filter?": {}
}

Get SmsMessages

Method: GET

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

Get a page of SmsMessages

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

Delete SmsMessage

Method: DELETE

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

Delete one SmsMessage

Authentication info only

Tasks

Create Task

Method: POST

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

Creates a new Task

{
  "organizationIds?": [
    "60398b0231a295e64f084fd9"
  ],
  "sharedWithOrganizations?": [
    [
      "60398b0231a295e64f084fd9"
    ]
  ],
  "text": "string",
  "completed?": "boolean",
  "description?": "string",
  "dueDate?": "Date",
  "assignedTo?": "string",
  "enduserId?": "string",
  "subscribers?": [
    "60398b0231a295e64f084fd9"
  ],
  "subscriberRoles?": [
    "example string"
  ]
}

Create Tasks

Method: POST

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

Creates new Tasks

{
  "create": [
    {
      "organizationIds?": [
        "60398b0231a295e64f084fd9"
      ],
      "sharedWithOrganizations?": [
        [
          "60398b0231a295e64f084fd9"
        ]
      ],
      "text": "string",
      "completed?": "boolean",
      "description?": "string",
      "dueDate?": "Date",
      "assignedTo?": "string",
      "enduserId?": "string",
      "subscribers?": [
        "60398b0231a295e64f084fd9"
      ],
      "subscriberRoles?": [
        "example string"
      ]
    }
  ]
}

Update Task

Method: PATCH

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

Updates Task fields

{
  "updates": {
    "organizationIds?": [
      "60398b0231a295e64f084fd9"
    ],
    "sharedWithOrganizations?": [
      [
        "60398b0231a295e64f084fd9"
      ]
    ],
    "text?": "string",
    "completed?": "boolean",
    "description?": "string",
    "dueDate?": "Date",
    "assignedTo?": "string",
    "enduserId?": "string",
    "subscribers?": [
      "60398b0231a295e64f084fd9"
    ],
    "subscriberRoles?": [
      "example string"
    ]
  },
  "options?": {
    "replaceObjectFields?": "boolean /* See Updating Records in Getting Started */"
  }
}

Get Task

Method: GET

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

Get an Task

{
  "filter?": {}
}

Get Tasks

Method: GET

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

Get a page of Tasks

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

Delete Task

Method: DELETE

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

Delete one Task

Authentication info only

Templates

Constraints

  • title must be unique across Templates

Get templated message

Method: GET

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

Returns a message with template values replaced

{
  "message": "string",
  "userId": "string",
  "enduserId": "string",
  "html?": "string",
  "channel?": "string"
}

Create Template

Method: POST

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

Creates a new Template

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

Create Templates

Method: POST

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

Creates new Templates

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

Update Template

Method: PATCH

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

Updates Template fields

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

Get Template

Method: GET

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

Get an Template

{
  "filter?": {}
}

Get Templates

Method: GET

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

Get a page of Templates

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

Delete Template

Method: DELETE

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

Delete one Template

Authentication info only

Tickets

Constraints

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

Create Ticket

Method: POST

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

Creates a new Ticket