For AI agents: visit https://docs.medchatapp.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Medchat
GuidesAPI ReferenceChangelog
Medchat
API Reference
GuidesAPI ReferenceChangelog

Chats API

  • ChatsV
    • Download chatsget
    • Get chatsget
    • Get user's chatsget
    • Get chat by IDget
    • Get user's chat by IDget
    • Submit form inputspost
    • Get chat tag by IDget
    • Get chat file by IDget

Live Chat API

  • ChatAttributes
    • Get attribute by IDget
    • Update attributeput
    • Create attributepost
  • ChatContext
    • Get message contextget
    • Get chat contextget
  • MessageKeywords
    • Get keywords.get
  • Messages
    • Get message by IDget
    • Post messagepost
    • Post user is typingpost
  • RegisteredChats
    • Get registered chat by IDget
    • Creates a registered chatpost
  • Transcript
    • Get a chat transcriptget
  • UserVerificationConfig
    • Get user verification configget
    • Create a user verification config.post

ChatBot Execution API

  • Execution
    • Resume chatbot executionpost
  • JourneyInstances
    • Creates journey instances.post
  • TextBotExecution
    • Resume textbot executionpost

Custom Reports API

  • Queries
    • Execute querypost

Asset Manager API

  • Assets
    • Get assets. Supports OData.get
    • It creates an asset.post
    • Get assets via json search params.post
    • Get asset by id.get
    • Update the asset.put
    • Patch the asset.patch
    • Delete the asset.del
    • Download the asset.get
    • Download the asset's thumbnail image.get
  • DataSets
    • Get data setsget
    • Create data setpost
    • Get data set by IDget
    • Update data setput
  • Folders
    • Get folders for the current org. Supports OData.get
    • Create a folder.post
    • Get Folder by it's IDget
    • Update folder.put
    • Deletes an empty folder.del
    • Gets all items within the folder.get

SMS Chat API

  • SmsChats
    • Gets all chats.get
  • SmsMessages
    • Post SMS messagepost
  • TextBotExecutions
    • Start text bot executionpost
    • Get text bot by execution IDget

MedChat Utility API

  • RetentionJobs
    • Creates a retention job.post
    • Lists retention jobs.get
    • Gets a retention job.get
    • Closes the retention job and deletes generated artifacts.del
    • Gets the extract file created.get

MedChat Auth

  • CustomUserAttributes
    • /v1/orgs/{orgId}/users/{userId}/customattributesget
    • /v1/orgs/{orgId}/users/{userId}/customattributes/{attributeId}get
    • /v1/orgs/{orgId}/users/{userId}/customattributesget
    • /v1/orgs/{orgId}/users/{userId}/customattributes/{attributeId}get

External Chats API V1

  • ExternalChatsFilesVersionless
Powered by 

ExternalChatsFilesVersionless

Updated 12 months ago


/v1/orgs/{orgId}/users/{userId}/customattributes/{attributeId}

Updated 12 months ago


/v1/orgs/{orgId}/users/{userId}/customattributes/{attributeId}