# Chat API ## Docs - [List of available agents](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Agents/get-agents.md): List available agents. - [Agent by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Agents/get-agents-id.md): Show agent by ID. - [Signed Login URL](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Auth/get-auth-signed-login-url.md): Create a temporary signed URL which logins the user into the messenger without having to provide any username or password. Useful for embedding the builtin messenger into iframes. URL is valid for three minutes. - [Delete Note by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/delete-conversation-conversationid-notes-noteid.md): Delete note by ID within a conversation. - [Delete Conversation by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/delete-conversations-id.md): Delete conversation by ID. - [List of available notes](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/get-conversation-conversationid-notes.md): List available notes within a conversation. - [Show Note by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/get-conversation-conversationid-notes-noteid.md): Show note by ID within a conversation. - [List of available conversations](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/get-conversations.md): List available conversations. - [Show Conversation by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/get-conversations-id.md): Show conversation by ID. - [Update Note by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/patch-conversation-conversationid-notes-noteid.md): Update a note within a conversation. - [Update conversation by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/patch-conversations-id.md): Update a conversation. - [Update conversation status](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/patch-conversations-id-status.md): Update status of conversation. DEPRECATED: use regular conversation update endpoint. - [Add a new note to a conversation](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/post-conversation-conversationid-notes.md): Add a new note to a conversation. - [Invite Rating](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/post-conversations-id-invite-rating.md): Generate a message containing an invite link for the user to leave a rating. - [Mark Read](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/post-conversations-id-mark-read.md): Mark all messages in a conversation as read. - [Mark Unread](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/post-conversations-id-mark-unread.md): Mark latest customer message in a conversation as unread (delivered). - [Parse Text](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/post-conversations-id-parse-text.md): Parse a text with placeholders. Context from conversation and profile. Currently supported placeholders are: $name$ -> profile.name $geburtsdatum$ -> profile.date_of_birth $telefon$ -> profile.phone_number $email$ -> profile.email $adresse$ -> profile.address $datum$ -> current date (e.g. 15.01.2020… - [Restart Conversation](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/post-conversations-id-restart.md): If this is a WhatsApp conversation it is possible to restart the conversation by calling this endpoint. A WhatsApp template message will be sent asking the customer if they want to continue the conversation. The template is a marketing message and will cost about 11 cents. This opens up a new 24 hou… - [Snooze Conversation](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Conversations/post-conversations-id-snooze.md): Snooze a conversation for a given amount of minutes and seconds. When time is over, status will change to "to-do" and a webhook of type "conversation-snoozed" will be sent. Use null or 0 to remove. Caution: scheduler will check every minute. - [Delete Customer by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Customers/delete-customers-id.md): Delete customer by ID. Attached profile and all customer data (messages, activities, etc) will be deleted. Deletion will be logged. See deletion log. - [List of available customers](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Customers/get-customers.md): List available customers. - [Show Customer by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Customers/get-customers-id.md): Show customer by ID. - [List users attached to a customer](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Customers/get-customers-id-users.md): List users attached to a customer. Used to show / hide customers for certain users. Users with role admin can always see and interact with all customers. User without that role must be explicitly added via this endpoint to be able so see and interact with the customer and conversation. The get route… - [Sync Users](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Customers/post-customers-id-users.md): Sync users with a customer. - [Export Csv](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Deletion logs/get-deletion-logs-export-csv.md): Returns a csv file containing all stored deletion logs of the last 3 years. - [Download File by UUID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Files/get-files-uuid.md): Download file by uuid. - [Temporary Upload](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Files/post-files-temporary-upload.md): Upload an image, video, audio or document. You can use the return object directly when creating a new message. An internal UUID will be generated. This UUID will be used instead of providing a public URL to a file. You can use the URL field, which is reachable from public, for use in Whatsapp templa… - [Whatsapp QR Code](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Marketing/get-marketing-whatsapp-qr-code.md): Generate WhatsApp link as QR code. - [Delete Message by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/delete-conversations-conversationid-messages-messageid.md): Delete message by ID. This will not delete messages on external services. - [List Messages](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/get-conversations-conversationid-messages.md): List latest (ordered desc) messages of conversation. - [Show Message by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/get-conversations-conversationid-messages-messageid.md): Show message by ID. - [Message Errors](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/get-conversations-conversationid-messages-messageid-errors.md): List message errors. - [Message Error by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/get-conversations-conversationid-messages-messageid-errors-errorid.md): Show message error by ID. - [Add a message to a conversation](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/post-conversations-conversationid-messages.md): Add a message from the agent to a conversation. - [Duplicate Message](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/post-conversations-conversationid-messages-messageid-duplicate.md): Duplicate an existing message. Message must be from agent. Can be used to retry a failed message. New message will be sent immediately. When message was based on a WhatsApp template, the template itself will not be used. Instead, the compiled message will be sent as a regular (e.g. text) message. - [Set Reaction](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Messages/post-conversations-conversationid-messages-messageid-set-reaction.md): Set agent reaction to message. - [Metric by month](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Metrics/get-metrics-year-month.md): Metric by month. Metrics are retained for 180 days. - [Delete Tag](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/delete-profiles-profileid-tags-tagid.md): Detach a tag from a profile. - [List available profiles](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/get-profiles.md): List available profiles. - [Show Profile by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/get-profiles-id.md): Show profile by ID. - [Activities](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/get-profiles-profileid-activities.md): List activities performed by a profile. - [Activity by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/get-profiles-profileid-activities-activityid.md): Show activity by ID performed by a profile. - [Profile Tags](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/get-profiles-profileid-tags.md): List tags attached to a profile. - [Update Profile](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/patch-profiles-id.md): Update profile. - [Marketing Opt In](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/post-profiles-id-marketing-opt-in.md): Update the current marketing opt in or opt out for a profile. This will generate an activity. The current opt in or opt out status can be determined by looking at activities. If there is an activity of type "marketing_opt_in" and no "marketing_opt_out" after that, the profile is opted in. - [Sync Tags](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Profiles/post-profiles-profileid-tags.md): Sync tags with a profile. Tags without ID will be created on the fly. - [Delete Rating](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Ratings/delete-ratings-id.md): Delete rating by ID. - [List of available ratings](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Ratings/get-ratings.md): List all ratings across conversations. Sorted by latest. - [Show Rating by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Ratings/get-ratings-id.md): Show rating by ID. - [Search Messages](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Search/post-search-messages.md): Search for messages. Up to 50 results will be returned. Bot messages will not be included. - [Search Tags](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Search/post-search-tags.md): Search for tags. Up to 100 results will be returned. - [CRM](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Settings/get-settings-crm.md): Get currently active CRM settings. - [General Settings](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Settings/get-settings-general.md): Get currently active general settings. - [Third Party Settings](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Settings/get-settings-third-party.md): Get currently active third party settings. - [Update CRM Settings](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Settings/patch-settings-crm.md): Update CRM settings. - [Update General Settings](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Settings/patch-settings-general.md): Update general settings. - [Update Third Party Settings](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Settings/patch-settings-third-party.md): Update third party settings. - [Activity Types](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Support/get-support-activity-types.md): Get info about activity types (used in profile activity) - [Allowed Mime Types](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Support/get-support-allowed-mime-types.md): Get info about allowed mime types per message type. - [Channels](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Support/get-support-channels.md): Get info about channels and channel capabilities. - [Media Size Limits](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Support/get-support-media-size-limits.md): Get info about allowed media file sizes in megabytes. - [Openapi Documentation](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Support/get-support-openapi.md): Return this document. - [Delete Tag](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Tags/delete-tags-id.md): Delete tag by ID. - [List Tags](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Tags/get-tags.md): List available tags. Sorted by title (ASC). - [Show Tag by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Tags/get-tags-id.md): Show tag by ID. - [Update Tag](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Tags/patch-tags-id.md): Update a tag. - [Create Tag](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Tags/post-tags.md): Add a new tag. - [Delete Template by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Templates/delete-templates-id.md): Delete template by ID. - [List Templates](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Templates/get-templates.md): List available templates. - [Show Template by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Templates/get-templates-id.md): Show template by ID. - [Update Template](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Templates/patch-templates-id.md): Update a template. - [Create Template](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Templates/post-templates.md): Add a new template. - [Delete User](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Users/delete-users-id.md): Delete user by ID. You cannot delete last admin user. - [List Users](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Users/get-users.md): List available users. - [Show User by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Users/get-users-id.md): Show user by ID. - [Create User](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Users/post-users.md): Add a new user. New user will be admin. - [Delete Template by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Whatsapp/delete-whatsapp-templates-id.md): Delete WhatsApp template by ID. All languages will be deleted. Actual deletion will take 4 weeks. You cannot submit a new template with a name which is currently in deletion. - [Get Agent Usage](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Whatsapp/get-whatsapp-agent-usage.md): Get current limit and usage (business initiated conversations) for WhatsApp agent. - [List WhatsApp Templates](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Whatsapp/get-whatsapp-templates.md): Get list of existing WhatsApp templates. - [Show WhatsApp Template by ID](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Whatsapp/get-whatsapp-templates-id.md): Show WhatsApp template by ID. - [Send Template](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Whatsapp/post-whatsapp-send-template.md): Send an approved WhatsApp template to a number. Customer and conversation will be created if not already existing. - [Submit Template for Approval](https://docs.chat.voicebot.studio/api-reference/endpoint/openapi/Whatsapp/post-whatsapp-templates.md): Submit a WhatsApp template for approval. Note: it is not possible to update existing templates via API. You can manually update templates by visiting the 360dialog page via https://wabamanagement.360dialog.io - [Introduction](https://docs.chat.voicebot.studio/api-reference/introduction.md): Chat API Documentation ## OpenAPI Specs - [bridge](https://docs.chat.voicebot.studio/api-reference/bridge.json) - [openapi](https://docs.chat.voicebot.studio/api-reference/openapi.json)