{ "openapi": "3.1.0", "info": { "title": "Chatwoot", "description": "This is the API documentation for Chatwoot server.", "version": "1.1.0", "termsOfService": "https://www.chatwoot.com/terms-of-service/", "contact": { "email": "hello@chatwoot.com" }, "license": { "name": "MIT License", "url": "https://opensource.org/licenses/MIT" } }, "servers": [ { "url": "https://app.chatwoot.com/" } ], "paths": { "/platform/api/v1/accounts": { "post": { "tags": [ "Accounts" ], "operationId": "create-an-account", "summary": "Create an Account", "description": "Create an Account", "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_create_update_payload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_account" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } }, "/platform/api/v1/accounts/{account_id}": { "parameters": [ { "$ref": "#/components/parameters/account_id" } ], "get": { "tags": [ "Accounts" ], "operationId": "get-details-of-an-account", "summary": "Get an account details", "description": "Get the details of an account", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_account" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The given account does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "patch": { "tags": [ "Accounts" ], "operationId": "update-an-account", "summary": "Update an account", "description": "Update an account's attributes", "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_create_update_payload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_account" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "delete": { "tags": [ "Accounts" ], "operationId": "delete-an-account", "summary": "Delete an Account", "description": "Delete an Account", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The account does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } }, "/platform/api/v1/accounts/{account_id}/account_users": { "parameters": [ { "$ref": "#/components/parameters/account_id" } ], "get": { "tags": [ "Account Users" ], "operationId": "list-all-account-users", "summary": "List all Account Users", "description": "List all account users", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_user" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "post": { "tags": [ "Account Users" ], "operationId": "create-an-account-user", "summary": "Create an Account User", "description": "Create an Account User", "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_user_create_update_payload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "account_id": { "type": "integer", "description": "The ID of the account" }, "user_id": { "type": "integer", "description": "The ID of the user" }, "role": { "type": "string", "description": "whether user is an administrator or agent" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "delete": { "tags": [ "Account Users" ], "operationId": "delete-an-account-user", "summary": "Delete an Account User", "description": "Delete an Account User", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The account does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } }, "/platform/api/v1/agent_bots": { "get": { "tags": [ "AgentBots" ], "operationId": "list-all-agent-bots", "summary": "List all AgentBots", "description": "List all agent bots available", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "description": "Array of agent bots", "items": { "$ref": "#/components/schemas/agent_bot" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "post": { "tags": [ "AgentBots" ], "operationId": "create-an-agent-bot", "summary": "Create an Agent Bot", "description": "Create an agent bot", "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_agent_bot_create_update_payload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_bot" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } }, "/platform/api/v1/agent_bots/{id}": { "parameters": [ { "$ref": "#/components/parameters/agent_bot_id" } ], "get": { "tags": [ "AgentBots" ], "operationId": "get-details-of-a-single-agent-bot", "summary": "Get an agent bot details", "description": "Get the details of an agent bot", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_bot" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The given agent bot ID does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "patch": { "tags": [ "AgentBots" ], "operationId": "update-an-agent-bot", "summary": "Update an agent bot", "description": "Update an agent bot's attributes", "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_agent_bot_create_update_payload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_bot" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "delete": { "tags": [ "AgentBots" ], "operationId": "delete-an-agent-bot", "summary": "Delete an AgentBot", "description": "Delete an AgentBot", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The agent bot does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } }, "/platform/api/v1/users": { "post": { "tags": [ "Users" ], "operationId": "create-a-user", "summary": "Create a User", "description": "Create a User", "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_create_update_payload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } }, "/platform/api/v1/users/{id}": { "parameters": [ { "$ref": "#/components/parameters/platform_user_id" } ], "get": { "tags": [ "Users" ], "operationId": "get-details-of-a-user", "summary": "Get an user details", "description": "Get the details of an user", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The given user does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "patch": { "tags": [ "Users" ], "operationId": "update-a-user", "summary": "Update a user", "description": "Update a user's attributes", "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_create_update_payload" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } }, "delete": { "tags": [ "Users" ], "operationId": "delete-a-user", "summary": "Delete a User", "description": "Delete a User", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The user does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } }, "/platform/api/v1/users/{id}/login": { "parameters": [ { "$ref": "#/components/parameters/platform_user_id" } ], "get": { "tags": [ "Users" ], "operationId": "get-sso-url-of-a-user", "summary": "Get User SSO Link", "description": "Get the sso link of a user", "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "SSO url to autenticate the user" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } }, "404": { "description": "The given user does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bad_request_error" } } } } } } } }, "components": { "schemas": { "bad_request_error": { "title": "data", "type": "object", "properties": { "description": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/request_error" } } } }, "request_error": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" } } }, "generic_id": { "type": "object", "properties": { "id": { "type": "number" } } }, "canned_response": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the canned response" }, "account_id": { "type": "integer", "description": "Account Id" }, "short_code": { "type": "string", "description": "Short Code for quick access of the canned response" }, "content": { "type": "string", "description": "Message content for canned response" }, "created_at": { "type": "string", "description": "The date and time when the canned response was created" }, "updated_at": { "type": "string", "description": "The date and time when the canned response was updated" } } }, "custom_attribute": { "type": "object", "properties": { "id": { "type": "integer", "description": "Identifier" }, "attribute_display_name": { "type": "string", "description": "Attribute display name" }, "attribute_display_type": { "type": "string", "description": "Attribute display type (text, number, currency, percent, link, date, list, checkbox)" }, "attribute_description": { "type": "string", "description": "Attribute description" }, "attribute_key": { "type": "string", "description": "Attribute unique key value" }, "regex_pattern": { "type": "string", "description": "Regex pattern" }, "regex_cue": { "type": "string", "description": "Regex cue" }, "attribute_values": { "type": "string", "description": "Attribute values" }, "attribute_model": { "type": "string", "description": "Attribute type(conversation_attribute/contact_attribute)" }, "default_value": { "type": "string", "description": "Attribute default value" }, "created_at": { "type": "string", "description": "The date and time when the custom attribute was created" }, "updated_at": { "type": "string", "description": "The date and time when the custom attribute was updated" } } }, "automation_rule": { "type": "object", "properties": { "payload": { "description": "Response payload that contains automation rule(s)", "oneOf": [ { "type": "array", "description": "Array of automation rules (for listing endpoint)", "items": { "$ref": "#/components/schemas/automation_rule_item" } }, { "type": "object", "description": "Single automation rule (for show/create/update endpoints)", "allOf": [ { "$ref": "#/components/schemas/automation_rule_item" } ] } ] } } }, "automation_rule_item": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the automation rule" }, "account_id": { "type": "integer", "description": "Account Id" }, "name": { "type": "string", "description": "The name of the rule", "example": "Add label on message create event" }, "description": { "type": "string", "description": "Description to give more context about the rule", "example": "Add label support and sales on message create event if incoming message content contains text help" }, "event_name": { "type": "string", "description": "Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)", "enum": [ "conversation_created", "conversation_updated", "message_created" ], "example": "message_created" }, "conditions": { "type": "array", "description": "Array of conditions on which conversation/message filter would work", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "attribute_key": { "type": "string" }, "query_operator": { "type": "string" }, "filter_operator": { "type": "string" } }, "example": { "attribute_key": "content", "filter_operator": "contains", "values": [ "help" ], "query_operator": "and" } } }, "actions": { "type": "array", "description": "Array of actions which we perform when condition matches", "items": { "type": "object", "properties": { "action_name": { "type": "string" }, "action_params": { "type": "array", "items": { "type": "string" } } }, "example": { "action_name": "add_label", "action_params": [ "support", "sales" ] } } }, "created_on": { "type": "integer", "description": "The timestamp when the rule was created" }, "active": { "type": "boolean", "description": "Enable/disable automation rule" } } }, "portal": { "type": "object", "properties": { "payload": { "type": "array", "items": { "$ref": "#/components/schemas/portal_item" } } } }, "portal_single": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/portal_item" } } }, "portal_config": { "type": "object", "description": "Configuration settings for the portal", "properties": { "allowed_locales": { "type": "array", "description": "List of allowed locales for the portal", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "The language code" }, "articles_count": { "type": "integer", "description": "Number of articles in this locale" }, "categories_count": { "type": "integer", "description": "Number of categories in this locale" } } } } } }, "portal_logo": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the logo file" }, "portal_id": { "type": "integer", "description": "ID of the portal this logo belongs to" }, "file_type": { "type": "string", "description": "MIME type of the file" }, "account_id": { "type": "integer", "description": "ID of the account" }, "file_url": { "type": "string", "description": "URL to access the logo file" }, "blob_id": { "type": "integer", "description": "ID of the blob" }, "filename": { "type": "string", "description": "Name of the file" } } }, "portal_meta": { "type": "object", "properties": { "all_articles_count": { "type": "integer", "description": "Total number of articles" }, "archived_articles_count": { "type": [ "integer", "null" ], "description": "Number of archived articles" }, "published_count": { "type": [ "integer", "null" ], "description": "Number of published articles" }, "draft_articles_count": { "type": [ "integer", "null" ], "description": "Number of draft articles" }, "categories_count": { "type": "integer", "description": "Number of categories" }, "default_locale": { "type": "string", "description": "Default locale for the portal" } } }, "portal_item": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the portal" }, "archived": { "type": "boolean", "description": "Whether the portal is archived" }, "color": { "type": "string", "description": "The color code for the portal" }, "config": { "$ref": "#/components/schemas/portal_config" }, "custom_domain": { "type": "string", "description": "Custom domain for the portal" }, "header_text": { "type": "string", "description": "The header text for the portal" }, "homepage_link": { "type": "string", "description": "Homepage link for the portal" }, "name": { "type": "string", "description": "Name of the portal" }, "slug": { "type": "string", "description": "URL slug for the portal" }, "page_title": { "type": "string", "description": "Page title for the portal" }, "account_id": { "type": "integer", "description": "ID of the account the portal belongs to" }, "inbox": { "$ref": "#/components/schemas/inbox" }, "logo": { "$ref": "#/components/schemas/portal_logo" }, "meta": { "$ref": "#/components/schemas/portal_meta" } } }, "category": { "type": "object", "properties": { "id": { "type": "integer" }, "description": { "type": "string", "description": "The text content." }, "locale": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "position": { "type": "integer" }, "portal_id": { "type": "integer" }, "account_id": { "type": "integer" }, "associated_category_id": { "type": "integer", "description": "To associate similar categories to each other, e.g same category of product documentation in different languages" }, "parent_category_id": { "type": "integer", "description": "To define parent category, e.g product documentation has multiple level features in sales category or in engineering category." } } }, "article": { "type": "object", "properties": { "id": { "type": "integer" }, "content": { "type": "string", "description": "The text content." }, "meta": { "type": "object" }, "position": { "type": "integer" }, "status": { "type": "integer", "enum": [ "draft", "published", "archived" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "views": { "type": "integer" }, "portal_id": { "type": "integer" }, "account_id": { "type": "integer" }, "author_id": { "type": "integer" }, "category_id": { "type": "integer" }, "folder_id": { "type": "integer" }, "associated_article_id": { "type": "integer", "description": "To associate similar articles to each other, e.g to provide the link for the reference." } } }, "contact": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object", "properties": { "additional_attributes": { "type": "object", "description": "The object containing additional attributes related to the contact" }, "availability_status": { "type": "string", "description": "The availability status of the contact" }, "email": { "type": "string", "description": "The email address of the contact" }, "id": { "type": "integer", "description": "The ID of the contact" }, "name": { "type": "string", "description": "The name of the contact" }, "phone_number": { "type": "string", "description": "The phone number of the contact" }, "blocked": { "type": "boolean", "description": "Whether the contact is blocked" }, "identifier": { "type": "string", "description": "The identifier of the contact" }, "thumbnail": { "type": "string", "description": "The thumbnail of the contact" }, "custom_attributes": { "type": "object", "description": "The custom attributes of the contact", "example": { "attribute_key": "attribute_value", "signed_up_at": "dd/mm/yyyy" } }, "last_activity_at": { "type": "integer", "description": "The last activity at of the contact" }, "created_at": { "type": "integer", "description": "The created at of the contact" }, "contact_inboxes": { "type": "array", "items": { "$ref": "#/components/schemas/contact_inboxes" } } } } } } }, "conversation": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the conversation" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/message" } }, "account_id": { "type": "number", "description": "Account Id" }, "uuid": { "type": "string", "description": "UUID of the conversation" }, "additional_attributes": { "type": "object", "description": "The object containing additional attributes related to the conversation" }, "agent_last_seen_at": { "type": "number", "description": "The last activity at of the agent" }, "assignee_last_seen_at": { "type": "number", "description": "The last activity at of the assignee" }, "can_reply": { "type": "boolean", "description": "Whether the conversation can be replied to" }, "contact_last_seen_at": { "type": "number", "description": "The last activity at of the contact" }, "custom_attributes": { "type": "object", "description": "The object to save custom attributes for conversation, accepts custom attributes key and value" }, "inbox_id": { "type": "number", "description": "ID of the inbox" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "The labels of the conversation" }, "muted": { "type": "boolean", "description": "Whether the conversation is muted" }, "snoozed_until": { "type": [ "number", "null" ], "description": "The time at which the conversation will be unmuted" }, "status": { "type": "string", "enum": [ "open", "resolved", "pending" ], "description": "The status of the conversation" }, "created_at": { "type": "number", "description": "The time at which conversation was created" }, "updated_at": { "type": "number", "description": "The time at which conversation was updated" }, "timestamp": { "type": "number", "description": "The time at which conversation was created" }, "first_reply_created_at": { "type": [ "number", "null" ], "description": "The time at which the first reply was created" }, "unread_count": { "type": "number", "description": "The number of unread messages" }, "last_non_activity_message": { "oneOf": [ { "$ref": "#/components/schemas/message" }, { "type": "null" } ], "description": "The last non activity message" }, "last_activity_at": { "type": "number", "description": "The last activity at of the conversation" }, "priority": { "type": [ "string", "null" ], "description": "The priority of the conversation" }, "waiting_since": { "type": [ "number", "null" ], "description": "The time at which the conversation was waiting" }, "sla_policy_id": { "type": [ "number", "null" ], "description": "The ID of the SLA policy" }, "applied_sla": { "type": "object", "description": "The applied SLA" }, "sla_events": { "type": "array", "items": { "type": "object", "description": "SLA event objects" } } } }, "message": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the message" }, "content": { "type": "string", "description": "The text content of the message" }, "account_id": { "type": "number", "description": "The ID of the account" }, "inbox_id": { "type": "number", "description": "The ID of the inbox" }, "conversation_id": { "type": "number", "description": "The ID of the conversation" }, "message_type": { "type": "integer", "enum": [ 0, 1, 2, 3 ], "description": "The type of the message" }, "created_at": { "type": "integer", "description": "The time at which message was created" }, "updated_at": { "type": [ "integer", "string" ], "description": "The time at which message was updated" }, "private": { "type": "boolean", "description": "The flags which shows whether the message is private or not" }, "status": { "type": [ "string", "null" ], "enum": [ "sent", "delivered", "read", "failed", null ], "description": "The status of the message" }, "source_id": { "type": [ "string", "null" ], "description": "The source ID of the message" }, "content_type": { "type": [ "string", "null" ], "enum": [ "text", "input_text", "input_textarea", "input_email", "input_select", "cards", "form", "article", "incoming_email", "input_csat", "integrations", "sticker", "voice_call", null ], "description": "The type of the template message" }, "content_attributes": { "type": "object", "description": "The content attributes for each content_type" }, "sender_type": { "type": [ "string", "null" ], "enum": [ "Contact", "User", "AgentBot", "Captain::Assistant", null ], "description": "The type of the sender" }, "sender_id": { "type": [ "number", "null" ], "description": "The ID of the sender" }, "external_source_ids": { "type": "object", "description": "The external source IDs of the message" }, "additional_attributes": { "type": "object", "description": "The additional attributes of the message" }, "processed_message_content": { "type": [ "string", "null" ], "description": "The processed message content" }, "sentiment": { "type": [ "object", "null" ], "description": "The sentiment of the message" }, "conversation": { "type": [ "object", "null" ], "description": "The conversation object" }, "attachment": { "type": [ "object", "null" ], "description": "The file object attached to the image" }, "sender": { "type": "object", "description": "User/Agent/AgentBot object" } } }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "access_token": { "type": "string" }, "account_id": { "type": "number" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "boolean" }, "display_name": { "type": [ "string", "null" ] }, "message_signature": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "hmac_identifier": { "type": "string" }, "inviter_id": { "type": [ "number", "null" ] }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "role": { "type": "string", "enum": [ "agent", "administrator" ] }, "ui_settings": { "type": "object" }, "uid": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "custom_attributes": { "type": "object", "description": "Available for users who are created through platform APIs and has custom attributes associated." }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "string" }, "active_at": { "type": [ "string", "null" ], "format": "date-time" }, "role": { "type": "string", "enum": [ "administrator", "agent" ] }, "permissions": { "type": "array", "items": { "type": "string" } }, "availability": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "boolean" }, "custom_role_id": { "type": [ "number", "null" ] }, "custom_role": { "type": [ "object", "null" ] } } } } } }, "agent": { "type": "object", "properties": { "id": { "type": "integer" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string", "enum": [ "online", "busy", "offline" ], "readOnly": true, "description": "The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability field in create or update requests." }, "auto_offline": { "type": "boolean", "description": "Whether the agent is automatically marked offline when they are away." }, "confirmed": { "type": "boolean", "description": "Whether the agent has confirmed their email address." }, "email": { "type": "string", "description": "The email of the agent" }, "available_name": { "type": "string", "description": "The available name of the agent" }, "name": { "type": "string", "description": "The name of the agent" }, "role": { "type": "string", "enum": [ "agent", "administrator" ], "description": "The role of the agent" }, "thumbnail": { "type": "string", "description": "The thumbnail of the agent" }, "custom_role_id": { "type": [ "integer", "null" ], "description": "The custom role id of the agent" } } }, "inbox": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the inbox" }, "name": { "type": "string", "description": "The name of the inbox" }, "website_url": { "type": [ "string", "null" ], "description": "Website URL" }, "page_id": { "type": [ "string", "null" ], "description": "Facebook Page ID associated with the inbox" }, "instagram_id": { "type": [ "string", "null" ], "description": "Instagram account ID associated with the inbox" }, "business_id": { "type": [ "string", "null" ], "description": "TikTok business ID associated with the inbox" }, "provider_name": { "type": [ "string", "null" ], "description": "Provider username or page name associated with the social inbox" }, "profile_id": { "type": [ "string", "null" ], "description": "X profile ID associated with the inbox" }, "line_channel_id": { "type": [ "string", "null" ], "description": "LINE channel ID associated with the inbox" }, "email": { "type": [ "string", "null" ], "description": "Email address associated with the inbox" }, "bot_name": { "type": [ "string", "null" ], "description": "Telegram bot name associated with the inbox" }, "inbox_identifier": { "type": [ "string", "null" ], "description": "Public identifier associated with an API inbox" }, "channel_type": { "type": "string", "description": "The type of the inbox" }, "avatar_url": { "type": "string", "description": "The avatar image of the inbox" }, "widget_color": { "type": [ "string", "null" ], "description": "Widget Color used for customization of the widget" }, "website_token": { "type": [ "string", "null" ], "description": "Website Token" }, "enable_auto_assignment": { "type": "boolean", "description": "The flag which shows whether Auto Assignment is enabled or not" }, "web_widget_script": { "type": [ "string", "null" ], "description": "Script used to load the website widget" }, "welcome_title": { "type": [ "string", "null" ], "description": "Welcome title to be displayed on the widget" }, "welcome_tagline": { "type": [ "string", "null" ], "description": "Welcome tagline to be displayed on the widget" }, "greeting_enabled": { "type": "boolean", "description": "The flag which shows whether greeting is enabled" }, "greeting_message": { "type": [ "string", "null" ], "description": "A greeting message when the user starts the conversation" }, "channel_id": { "type": "number", "description": "ID of the channel this inbox belongs to" }, "working_hours_enabled": { "type": "boolean", "description": "The flag which shows whether working hours feature is enabled" }, "enable_email_collect": { "type": "boolean", "description": "The flag to enable collecting email from contacts" }, "csat_survey_enabled": { "type": "boolean", "description": "The flag to enable CSAT survey" }, "auto_assignment_config": { "type": "object", "description": "Configuration settings for auto assignment" }, "out_of_office_message": { "type": [ "string", "null" ], "description": "Message to show when agents are out of office" }, "working_hours": { "type": "array", "description": "Configuration for working hours of the inbox", "items": { "type": "object", "properties": { "day_of_week": { "type": "number", "description": "Day of the week (0-6, where 0 is Sunday)" }, "closed_all_day": { "type": "boolean", "description": "Whether the inbox is closed for the entire day" }, "open_hour": { "type": [ "number", "null" ], "description": "Hour when inbox opens (0-23)" }, "open_minutes": { "type": [ "number", "null" ], "description": "Minutes of the hour when inbox opens (0-59)" }, "close_hour": { "type": [ "number", "null" ], "description": "Hour when inbox closes (0-23)" }, "close_minutes": { "type": [ "number", "null" ], "description": "Minutes of the hour when inbox closes (0-59)" }, "open_all_day": { "type": "boolean", "description": "Whether the inbox is open for the entire day" } } } }, "timezone": { "type": "string", "description": "Timezone configuration for the inbox" }, "callback_webhook_url": { "type": [ "string", "null" ], "description": "Webhook URL for callbacks" }, "allow_messages_after_resolved": { "type": "boolean", "description": "Whether to allow messages after a conversation is resolved" }, "lock_to_single_conversation": { "type": "boolean", "description": "Whether to lock a contact to a single conversation" }, "sender_name_type": { "type": "string", "description": "Type of sender name to display (e.g., friendly)" }, "business_name": { "type": [ "string", "null" ], "description": "Business name associated with the inbox" }, "branded_email_layout": { "type": [ "string", "null" ], "description": "Liquid HTML layout for branded email replies. Available to administrators for Email inbox show/update responses." }, "hmac_mandatory": { "type": [ "boolean", "null" ], "description": "Whether HMAC verification is mandatory" }, "selected_feature_flags": { "type": [ "array", "null" ], "description": "Selected feature flags for the inbox", "items": { "type": "string" } }, "reply_time": { "type": [ "string", "null" ], "description": "Expected reply time" }, "messaging_service_sid": { "type": [ "string", "null" ], "description": "Messaging service SID for SMS providers" }, "phone_number": { "type": [ "string", "null" ], "description": "Phone number associated with the inbox" }, "medium": { "type": "string", "description": "Medium of communication (e.g., sms, email)" }, "provider": { "type": [ "string", "null" ], "description": "Provider of the channel" } } }, "branded_email_layout": { "type": "object", "properties": { "branded_email_layout": { "type": [ "string", "null" ], "description": "Account-scoped Liquid HTML layout for branded email replies.", "example": "{{ content_for_layout }}" } } }, "inbox_contact": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the inbox" }, "avatar_url": { "type": "string", "description": "The avatar image of the inbox" }, "channel_id": { "type": "number", "description": "The ID of the channel" }, "name": { "type": "string", "description": "The name of the inbox" }, "channel_type": { "type": "string", "description": "The type of the inbox" }, "provider": { "type": "string", "description": "The provider of the inbox" } } }, "agent_bot": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the agent bot" }, "name": { "type": "string", "description": "The name of the agent bot" }, "description": { "type": "string", "description": "The description about the agent bot" }, "thumbnail": { "type": "string", "description": "The thumbnail of the agent bot" }, "outgoing_url": { "type": "string", "description": "The webhook URL for the bot" }, "bot_type": { "type": "string", "description": "The type of the bot" }, "bot_config": { "type": "object", "description": "The configuration of the bot" }, "account_id": { "type": "number", "description": "Account ID if it's an account specific bot" }, "access_token": { "type": "string", "description": "The access token for the bot" }, "system_bot": { "type": "boolean", "description": "Whether the bot is a system bot" } } }, "contact_inboxes": { "type": "object", "properties": { "source_id": { "type": "string", "description": "Contact Inbox Source Id" }, "inbox": { "$ref": "#/components/schemas/inbox_contact" } } }, "contactable_inboxes": { "type": "object", "properties": { "source_id": { "type": "string", "description": "Contact Inbox Source Id" }, "inbox": { "$ref": "#/components/schemas/inbox" } } }, "custom_filter": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the custom filter" }, "name": { "type": "string", "description": "The name of the custom filter" }, "type": { "type": "string", "enum": [ "conversation", "contact", "report" ], "description": "The description about the custom filter" }, "query": { "type": "object", "description": "A query that needs to be saved as a custom filter" }, "created_at": { "type": "string", "format": "date-time", "description": "The time at which the custom filter was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time at which the custom filter was updated" } } }, "webhook": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the webhook" }, "url": { "type": "string", "description": "The url to which the events will be send" }, "name": { "type": "string", "description": "The name of the webhook" }, "subscriptions": { "type": "array", "items": { "type": "string", "enum": [ "conversation_created", "conversation_status_changed", "conversation_updated", "contact_created", "contact_updated", "message_created", "message_updated", "webwidget_triggered", "conversation_typing_on", "conversation_typing_off" ] }, "description": "The list of subscribed events" }, "secret": { "type": "string", "nullable": true, "description": "Secret used to sign webhook requests. Signed webhook deliveries include `X-Chatwoot-Timestamp` and `X-Chatwoot-Signature`; the signature is `sha256=` followed by the HMAC-SHA256 of `{timestamp}.{raw_request_body}` using this secret. Deliveries also include `X-Chatwoot-Delivery` when a delivery id is available." }, "account_id": { "type": "number", "description": "The id of the account which the webhook object belongs to" } } }, "account": { "type": "object", "properties": { "id": { "type": "number", "description": "Account ID" }, "name": { "type": "string", "description": "Name of the account" }, "role": { "type": "string", "enum": [ "administrator", "agent" ], "description": "The user role in the account" } } }, "account_detail": { "type": "object", "properties": { "id": { "type": "number", "description": "Account ID" }, "name": { "type": "string", "description": "Name of the account" }, "locale": { "type": "string", "description": "The locale of the account" }, "domain": { "type": "string", "description": "The domain of the account" }, "support_email": { "type": "string", "description": "The support email of the account" }, "status": { "type": "string", "description": "The status of the account" }, "created_at": { "type": "string", "format": "date-time", "description": "The creation date of the account" }, "cache_keys": { "type": "object", "description": "Cache keys for the account" }, "features": { "type": "object", "description": "Enabled features for the account" }, "settings": { "type": "object", "description": "Account settings", "properties": { "auto_resolve_after": { "type": "number", "description": "Auto resolve conversations after specified minutes" }, "auto_resolve_message": { "type": "string", "description": "Message to send when auto resolving" }, "auto_resolve_ignore_waiting": { "type": "boolean", "description": "Whether to ignore waiting conversations for auto resolve" } } }, "custom_attributes": { "type": "object", "description": "Custom attributes of the account", "properties": { "plan_name": { "type": [ "string", "null" ], "description": "Subscription plan name" }, "subscribed_quantity": { "type": [ "number", "null" ], "description": "Subscribed quantity" }, "subscription_status": { "type": [ "string", "null" ], "description": "Subscription status" }, "subscription_ends_on": { "type": [ "string", "null" ], "format": "date", "description": "Subscription end date" }, "industry": { "type": "string", "description": "Industry type" }, "company_size": { "type": "string", "description": "Company size" }, "timezone": { "type": "string", "description": "Account timezone" }, "logo": { "type": "string", "description": "Account logo URL" }, "onboarding_step": { "type": "string", "description": "Current onboarding step" }, "marked_for_deletion_at": { "type": "string", "format": "date-time", "description": "When account was marked for deletion" }, "marked_for_deletion_reason": { "type": "string", "description": "Reason for account deletion" } } } } }, "account_show_response": { "allOf": [ { "$ref": "#/components/schemas/account_detail" }, { "type": "object", "properties": { "latest_chatwoot_version": { "type": [ "string", "null" ], "description": "Latest version of Chatwoot available", "example": "3.0.0" }, "subscribed_features": { "type": "array", "items": { "type": "string" }, "description": "List of subscribed enterprise features (if enterprise edition is enabled)" } } } ] }, "account_user": { "type": "array", "description": "Array of account users", "items": { "type": "object", "properties": { "account_id": { "type": "integer", "description": "The ID of the account" }, "user_id": { "type": "integer", "description": "The ID of the user" }, "role": { "type": "string", "description": "whether user is an administrator or agent" } } } }, "platform_account": { "type": "object", "properties": { "id": { "type": "number", "description": "Account ID" }, "name": { "type": "string", "description": "Name of the account" } } }, "team": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the team" }, "name": { "type": "string", "description": "The name of the team" }, "description": { "type": [ "string", "null" ], "description": "The description about the team" }, "allow_auto_assign": { "type": "boolean", "description": "If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team" }, "account_id": { "type": "number", "description": "The ID of the account with the team is a part of" }, "is_member": { "type": "boolean", "description": "This field shows whether the current user is a part of the team" } } }, "label": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the label" }, "title": { "type": "string", "description": "The title of the label" }, "description": { "type": "string", "description": "The description of the label" }, "color": { "type": "string", "description": "Hex color code for the label" }, "show_on_sidebar": { "type": "boolean", "description": "Whether the label should appear in the sidebar" } } }, "integrations_app": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the integration" }, "name": { "type": "string", "description": "The name of the integration" }, "description": { "type": "string", "description": "The description about the team" }, "hook_type": { "type": "string", "description": "Whether the integration is an account or inbox integration" }, "enabled": { "type": "boolean", "description": "Whether the integration is enabled for the account" }, "allow_multiple_hooks": { "type": "boolean", "description": "Whether multiple hooks can be created for the integration" }, "hooks": { "type": "array", "items": { "type": "object" }, "description": "If there are any hooks created for this integration" } } }, "integrations_hook": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the integration hook" }, "app_id": { "type": "string", "description": "The ID of the integration app" }, "inbox_id": { "type": "string", "description": "Inbox ID if its an Inbox integration" }, "account_id": { "type": "string", "description": "Account ID of the integration" }, "status": { "type": "boolean", "description": "Whether the integration hook is enabled for the account" }, "hook_type": { "type": "boolean", "description": "Whether its an account or inbox integration hook" }, "settings": { "type": "object", "description": "The associated settings for the integration" } } }, "audit_log": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the audit log entry" }, "auditable_id": { "type": "integer", "description": "The ID of the audited object" }, "auditable_type": { "type": "string", "description": "The type of the audited object (e.g., Conversation, Contact, User)" }, "auditable": { "type": "object", "description": "The audited object data" }, "associated_id": { "type": "integer", "description": "The ID of the associated object (typically the account ID)" }, "associated_type": { "type": "string", "description": "The type of the associated object" }, "user_id": { "type": "integer", "description": "The ID of the user who performed the action" }, "user_type": { "type": "string", "description": "The type of user who performed the action" }, "username": { "type": "string", "description": "The email/username of the user who performed the action" }, "action": { "type": "string", "enum": [ "create", "update", "destroy" ], "description": "The action performed on the object" }, "audited_changes": { "type": "object", "description": "JSON object containing the changes made to the audited object" }, "version": { "type": "integer", "description": "Version number of the audit log entry" }, "comment": { "type": [ "string", "null" ], "description": "Optional comment associated with the audit log entry" }, "request_uuid": { "type": "string", "description": "UUID to identify the request that generated this audit log" }, "created_at": { "type": "integer", "description": "Unix timestamp when the audit log entry was created" }, "remote_address": { "type": [ "string", "null" ], "description": "IP address from which the action was performed" } } }, "public_contact": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the contact" }, "source_id": { "type": "string", "description": "The session identifier of the contact" }, "name": { "type": [ "string", "null" ], "description": "Name of the contact when available" }, "email": { "type": [ "string", "null" ], "description": "Email of the contact" }, "phone_number": { "type": [ "string", "null" ], "description": "Phone number of the contact" }, "pubsub_token": { "type": "string", "description": "The token to be used to connect to chatwoot websocket" } } }, "public_contact_record": { "type": "object", "additionalProperties": true, "description": "Full serialized contact record returned when the public API renders a Contact model directly.", "properties": { "id": { "type": "integer", "description": "Id of the contact" }, "name": { "type": [ "string", "null" ], "description": "Name of the contact when available" }, "email": { "type": [ "string", "null" ], "description": "Email of the contact" }, "phone_number": { "type": [ "string", "null" ], "description": "Phone number of the contact" }, "identifier": { "type": [ "string", "null" ], "description": "Identifier of the contact" }, "blocked": { "type": "boolean", "description": "Whether the contact is blocked" }, "additional_attributes": { "type": [ "object", "null" ], "description": "Additional attributes of the contact when present" }, "custom_attributes": { "type": [ "object", "null" ], "description": "Custom attributes of the contact when present" }, "contact_type": { "type": [ "string", "null" ], "description": "Contact type of the contact when available" }, "country_code": { "type": [ "string", "null" ], "description": "Country code of the contact" }, "last_activity_at": { "type": [ "string", "null" ], "description": "Last activity timestamp of the contact in ISO 8601 format" }, "created_at": { "type": [ "string", "null" ], "description": "Created timestamp of the contact in ISO 8601 format" }, "updated_at": { "type": [ "string", "null" ], "description": "Updated timestamp of the contact in ISO 8601 format" }, "last_name": { "type": [ "string", "null" ], "description": "Last name of the contact" }, "middle_name": { "type": [ "string", "null" ], "description": "Middle name of the contact" }, "location": { "type": [ "string", "null" ], "description": "Location of the contact" }, "account_id": { "type": "integer", "description": "Account id of the contact" }, "company_id": { "type": [ "integer", "null" ], "description": "Company id of the contact" }, "label_list": { "type": "array", "description": "Labels applied to the contact", "items": { "type": "string" } } } }, "public_conversation": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the conversation" }, "uuid": { "type": "string", "description": "UUID of the conversation" }, "inbox_id": { "type": "integer", "description": "The inbox id of the conversation" }, "contact_last_seen_at": { "type": "integer", "description": "Timestamp of when the contact last seen the conversation (Unix timestamp)" }, "status": { "type": "string", "enum": [ "open", "resolved", "pending", "snoozed" ], "description": "The status of the conversation" }, "agent_last_seen_at": { "type": "integer", "description": "Timestamp of when the agent last seen the conversation (Unix timestamp)" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/public_message" }, "description": "Messages in the conversation" }, "contact": { "$ref": "#/components/schemas/public_contact_record" } } }, "public_message": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the message" }, "content": { "type": [ "string", "null" ], "description": "Text content of the message. Can be null for attachment-only messages." }, "message_type": { "type": "integer", "description": "Denotes the message type. Possible values: 0 (incoming), 1 (outgoing), 2 (activity), 3 (template)" }, "content_type": { "type": "string", "description": "Content type of the message" }, "content_attributes": { "type": "object", "description": "Additional content attributes of the message" }, "created_at": { "type": "integer", "description": "Created at Unix timestamp of the message" }, "conversation_id": { "type": "integer", "description": "Display Id of the conversation the message belongs to" }, "attachments": { "type": "array", "description": "Attachments if any", "items": { "$ref": "#/components/schemas/public_message_attachment" } }, "sender": { "$ref": "#/components/schemas/public_message_sender" } } }, "public_message_attachment": { "type": "object", "additionalProperties": true, "description": "Attachment payload. Available fields vary by attachment file_type.", "properties": { "id": { "type": "integer", "description": "Id of the attachment" }, "message_id": { "type": "integer", "description": "Id of the parent message" }, "file_type": { "type": "string", "enum": [ "image", "audio", "video", "file", "location", "fallback", "share", "story_mention", "contact", "ig_reel", "ig_post", "ig_story", "embed" ], "description": "Type of the attached file" }, "account_id": { "type": "integer", "description": "Id of the account" }, "extension": { "type": [ "string", "null" ], "description": "File extension" }, "data_url": { "type": [ "string", "null" ], "description": "URL of the file. Can be null when an attachment variant has no external URL." }, "thumb_url": { "type": "string", "description": "URL of the file thumbnail" }, "file_size": { "type": "integer", "description": "File size in bytes" }, "width": { "type": [ "integer", "null" ], "description": "Width of the attachment when available" }, "height": { "type": [ "integer", "null" ], "description": "Height of the attachment when available" }, "coordinates_lat": { "type": "number", "description": "Latitude for location attachments" }, "coordinates_long": { "type": "number", "description": "Longitude for location attachments" }, "fallback_title": { "type": [ "string", "null" ], "description": "Fallback title for location, fallback, and contact attachments when available" }, "meta": { "type": "object", "description": "Metadata for contact attachments" }, "transcribed_text": { "type": "string", "description": "Transcribed text for audio attachments" } } }, "public_message_sender": { "type": "object", "additionalProperties": true, "description": "Polymorphic sender payload returned by push_event_data. Available fields vary by sender type.", "properties": { "id": { "type": "integer", "description": "Id of the sender" }, "name": { "type": [ "string", "null" ], "description": "Name of the sender when available" }, "avatar_url": { "type": "string", "description": "Avatar URL of the sender. Present for senders of type user, agent_bot, and captain_assistant. Not present for contact senders (use thumbnail instead)." }, "thumbnail": { "type": "string", "description": "Avatar/thumbnail URL of the sender. Contact senders use this field; user senders may also include it." }, "type": { "type": "string", "enum": [ "contact", "user", "agent_bot", "captain_assistant" ], "description": "Type of the sender" }, "available_name": { "type": [ "string", "null" ], "description": "Display name for user senders" }, "availability_status": { "type": [ "string", "null" ], "description": "Availability status for user senders" }, "email": { "type": [ "string", "null" ], "description": "Email of the sender when the sender is a contact" }, "phone_number": { "type": [ "string", "null" ], "description": "Phone number of the sender when the sender is a contact" }, "identifier": { "type": [ "string", "null" ], "description": "Identifier of the sender when the sender is a contact" }, "blocked": { "type": "boolean", "description": "Whether the sender is blocked when the sender is a contact" }, "additional_attributes": { "type": [ "object", "null" ], "description": "Additional attributes when the sender is a contact and available" }, "custom_attributes": { "type": [ "object", "null" ], "description": "Custom attributes when the sender is a contact and available" }, "description": { "type": [ "string", "null" ], "description": "Description when the sender is a captain assistant" }, "created_at": { "type": [ "string", "null" ], "description": "Created timestamp in ISO 8601 format when the sender is a captain assistant" } } }, "public_inbox": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Inbox identifier" }, "name": { "type": "string", "description": "Name of the inbox" }, "timezone": { "type": "string", "description": "The timezone defined on the inbox" }, "working_hours": { "type": "array", "description": "The working hours defined on the inbox", "items": { "type": "object", "properties": { "day_of_week": { "type": "integer", "description": "Day of the week as a number. Sunday -> 0, Saturday -> 6" }, "open_all_day": { "type": "boolean", "description": "Whether or not the business is open the whole day" }, "closed_all_day": { "type": "boolean", "description": "Whether or not the business is closed the whole day" }, "open_hour": { "type": "integer", "description": "Opening hour. Can be null if closed all day" }, "open_minutes": { "type": "integer", "description": "Opening minute. Can be null if closed all day" }, "close_hour": { "type": "integer", "description": "Closing hour. Can be null if closed all day" }, "close_minutes": { "type": "integer", "description": "Closing minute. Can be null if closed all day" } } } }, "working_hours_enabled": { "type": "boolean", "description": "Whether of not the working hours are enabled on the inbox" }, "csat_survey_enabled": { "type": "boolean", "description": "Whether of not the Customer Satisfaction survey is enabled on the inbox" }, "greeting_enabled": { "type": "boolean", "description": "Whether of not the Greeting Message is enabled on the inbox" }, "identity_validation_enabled": { "type": "boolean", "description": "Whether of not the User Identity Validation is enforced on the inbox" } } }, "account_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the account", "example": "My Account" }, "locale": { "type": "string", "description": "The locale of the account", "example": "en" }, "domain": { "type": "string", "description": "The domain of the account", "example": "example.com" }, "support_email": { "type": "string", "description": "The support email of the account", "example": "support@example.com" }, "status": { "type": "string", "enum": [ "active", "suspended" ], "description": "The status of the account", "example": "active" }, "limits": { "type": "object", "description": "The limits of the account", "example": {} }, "custom_attributes": { "type": "object", "description": "The custom attributes of the account", "example": {} } } }, "account_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the account", "example": "My Account" }, "locale": { "type": "string", "description": "The locale of the account", "example": "en" }, "domain": { "type": "string", "description": "The domain of the account", "example": "example.com" }, "support_email": { "type": "string", "description": "The support email of the account", "example": "support@example.com" }, "auto_resolve_after": { "type": [ "integer", "null" ], "minimum": 10, "maximum": 1439856, "description": "Auto resolve conversations after specified minutes", "example": 1440 }, "auto_resolve_message": { "type": [ "string", "null" ], "description": "Message to send when auto resolving", "example": "This conversation has been automatically resolved due to inactivity" }, "auto_resolve_ignore_waiting": { "type": [ "boolean", "null" ], "description": "Whether to ignore waiting conversations for auto resolve", "example": false }, "industry": { "type": "string", "description": "Industry type", "example": "Technology" }, "company_size": { "type": "string", "description": "Company size", "example": "50-100" }, "timezone": { "type": "string", "description": "Account timezone", "example": "UTC" } } }, "account_user_create_update_payload": { "type": "object", "required": [ "user_id", "role" ], "properties": { "user_id": { "type": "integer", "description": "The ID of the user", "example": 1 }, "role": { "type": "string", "description": "whether user is an administrator or agent", "example": "administrator" } } }, "platform_agent_bot_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the agent bot", "example": "My Agent Bot" }, "description": { "type": "string", "description": "The description of the agent bot", "example": "This is a sample agent bot" }, "outgoing_url": { "type": "string", "description": "The webhook URL for the bot", "example": "https://example.com/webhook" }, "account_id": { "type": "integer", "description": "The account ID to associate the agent bot with", "example": 1 }, "avatar": { "type": "string", "format": "binary", "description": "Send the form data with the avatar image binary or use the avatar_url" }, "avatar_url": { "type": "string", "description": "The url to a jpeg, png file for the agent bot avatar", "example": "https://example.com/avatar.png" } } }, "agent_bot_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the agent bot", "example": "My Agent Bot" }, "description": { "type": "string", "description": "The description of the agent bot", "example": "This is a sample agent bot" }, "outgoing_url": { "type": "string", "description": "The webhook URL for the bot", "example": "https://example.com/webhook" }, "avatar": { "type": "string", "format": "binary", "description": "Send the form data with the avatar image binary or use the avatar_url" }, "avatar_url": { "type": "string", "description": "The url to a jpeg, png file for the agent bot avatar", "example": "https://example.com/avatar.png" }, "bot_type": { "type": "integer", "description": "The type of the bot (0 for webhook)", "example": 0 }, "bot_config": { "type": "object", "description": "The configuration for the bot", "example": {} } } }, "user_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the user", "example": "Daniel" }, "display_name": { "type": "string", "description": "Display name of the user", "example": "Dan" }, "email": { "type": "string", "description": "Email of the user", "example": "daniel@acme.inc" }, "password": { "type": "string", "description": "Password must contain uppercase, lowercase letters, number and a special character", "example": "Password2!" }, "custom_attributes": { "type": "object", "description": "Custom attributes you want to associate with the user", "example": {} } } }, "canned_response_create_update_payload": { "type": "object", "properties": { "content": { "type": "string", "description": "Message content for canned response", "example": "Hello, {{contact.name}}! Welcome to our service." }, "short_code": { "type": "string", "description": "Short Code for quick access of the canned response", "example": "welcome" } } }, "custom_attribute_create_update_payload": { "type": "object", "properties": { "attribute_display_name": { "type": "string", "description": "Attribute display name", "example": "Custom Attribute" }, "attribute_display_type": { "type": "integer", "description": "Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)", "example": 0 }, "attribute_description": { "type": "string", "description": "Attribute description", "example": "This is a custom attribute" }, "attribute_key": { "type": "string", "description": "Attribute unique key value", "example": "custom_attribute" }, "attribute_values": { "type": "array", "description": "Attribute values", "items": { "type": "string" }, "example": [ "value1", "value2" ] }, "attribute_model": { "type": "integer", "description": "Attribute type(conversation_attribute- 0, contact_attribute- 1)", "example": 0 }, "regex_pattern": { "type": "string", "description": "Regex pattern (Only applicable for type- text). The regex pattern is used to validate the attribute value(s).", "example": "^[a-zA-Z0-9]+$" }, "regex_cue": { "type": "string", "description": "Regex cue message (Only applicable for type- text). The cue message is shown when the regex pattern is not matched.", "example": "Please enter a valid value" } } }, "agent_create_payload": { "type": "object", "required": [ "name", "email", "role" ], "properties": { "name": { "type": "string", "description": "Full Name of the agent", "example": "John Doe" }, "email": { "type": "string", "description": "Email of the Agent", "example": "john.doe@acme.inc" }, "role": { "type": "string", "enum": [ "agent", "administrator" ], "description": "Whether its administrator or agent", "example": "agent" }, "availability": { "type": "string", "enum": [ "online", "busy", "offline" ], "description": "The configured availability of the agent.", "example": "online" }, "auto_offline": { "type": "boolean", "description": "Whether the agent is automatically marked offline when they are away.", "example": true } } }, "agent_update_payload": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "string", "enum": [ "agent", "administrator" ], "description": "Whether its administrator or agent", "example": "agent" }, "availability": { "type": "string", "enum": [ "online", "busy", "offline" ], "description": "The configured availability of the agent.", "example": "online" }, "auto_offline": { "type": "boolean", "description": "Whether the agent is automatically marked offline when they are away.", "example": true } } }, "contact_create_payload": { "type": "object", "required": [ "inbox_id" ], "properties": { "inbox_id": { "type": "number", "description": "ID of the inbox to which the contact belongs", "example": 1 }, "name": { "type": "string", "description": "name of the contact", "example": "Alice" }, "email": { "type": "string", "description": "email of the contact", "example": "alice@acme.inc" }, "blocked": { "type": "boolean", "description": "whether the contact is blocked or not", "example": false }, "phone_number": { "type": "string", "description": "phone number of the contact", "example": "+123456789" }, "avatar": { "type": "string", "format": "binary", "description": "Send the form data with the avatar image binary or use the avatar_url" }, "avatar_url": { "type": "string", "description": "The url to a jpeg, png file for the contact avatar", "example": "https://example.com/avatar.png" }, "identifier": { "type": "string", "description": "A unique identifier for the contact in external system", "example": "1234567890" }, "additional_attributes": { "type": "object", "description": "An object where you can store additional attributes for contact. example {\"type\":\"customer\", \"age\":30}", "example": { "type": "customer", "age": 30 } }, "custom_attributes": { "type": "object", "description": "An object where you can store custom attributes for contact. example {\"type\":\"customer\", \"age\":30}, this should have a valid custom attribute definition.", "example": {} } } }, "contact_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "name of the contact", "example": "Alice" }, "email": { "type": "string", "description": "email of the contact", "example": "alice@acme.inc" }, "blocked": { "type": "boolean", "description": "whether the contact is blocked or not", "example": false }, "phone_number": { "type": "string", "description": "phone number of the contact", "example": "+123456789" }, "avatar": { "type": "string", "format": "binary", "description": "Send the form data with the avatar image binary or use the avatar_url" }, "avatar_url": { "type": "string", "description": "The url to a jpeg, png file for the contact avatar", "example": "https://example.com/avatar.png" }, "identifier": { "type": "string", "description": "A unique identifier for the contact in external system", "example": "1234567890" }, "additional_attributes": { "type": "object", "description": "An object where you can store additional attributes for contact. example {\"type\":\"customer\", \"age\":30}", "example": { "type": "customer", "age": 30 } }, "custom_attributes": { "type": "object", "description": "An object where you can store custom attributes for contact. example {\"type\":\"customer\", \"age\":30}, this should have a valid custom attribute definition.", "example": {} } } }, "conversation_create_payload": { "type": "object", "required": [ "source_id" ], "properties": { "source_id": { "type": "string", "description": "Conversation source id", "example": "1234567890" }, "inbox_id": { "type": "integer", "description": "Id of inbox in which the conversation is created
Allowed Inbox Types: Website, Phone, Api, Email", "example": 1 }, "contact_id": { "type": "integer", "description": "Contact Id for which conversation is created", "example": 1 }, "additional_attributes": { "type": "object", "description": "Lets you specify attributes like browser information", "example": { "browser": "Chrome", "browser_version": "89.0.4389.82", "os": "Windows", "os_version": "10" } }, "custom_attributes": { "type": "object", "description": "The object to save custom attributes for conversation, accepts custom attributes key and value", "example": { "attribute_key": "attribute_value", "priority_conversation_number": 3 } }, "status": { "type": "string", "enum": [ "open", "resolved", "pending" ], "description": "Specify the conversation whether it's pending, open, closed", "example": "open" }, "assignee_id": { "type": "integer", "description": "Agent Id for assigning a conversation to an agent", "example": 1 }, "team_id": { "type": "integer", "description": "Team Id for assigning a conversation to a team\\", "example": 1 }, "snoozed_until": { "type": "string", "format": "date-time", "description": "Snoozed until date time", "example": "2030-07-21T17:32:28Z" }, "message": { "type": "object", "description": "The initial message to be sent to the conversation", "required": [ "content" ], "properties": { "content": { "type": "string", "description": "The content of the message", "example": "Hello, how can I help you?" }, "template_params": { "type": "object", "description": "The template params for the message in case of whatsapp Channel", "properties": { "name": { "type": "string", "description": "Name of the template", "example": "sample_issue_resolution" }, "category": { "type": "string", "description": "Category of the template", "example": "UTILITY" }, "language": { "type": "string", "description": "Language of the template", "example": "en_US" }, "processed_params": { "type": "object", "description": "The processed param values for template variables in template", "example": { "1": "Chatwoot" } } } } } } } }, "conversation_message_create_payload": { "type": "object", "required": [ "content" ], "properties": { "content": { "type": "string", "description": "The content of the message", "example": "Hello, how can I help you?" }, "message_type": { "type": "string", "enum": [ "outgoing", "incoming" ], "description": "The type of the message", "example": "outgoing" }, "private": { "type": "boolean", "description": "Flag to identify if it is a private note", "example": false }, "content_type": { "type": "string", "enum": [ "text", "input_email", "cards", "input_select", "form", "article" ], "description": "Content type of the message", "example": "text" }, "content_attributes": { "type": "object", "description": "Attributes based on the content type. For `input_select`, provide an `items` array with\n`title`, `value`, and optional `description`. WhatsApp list messages use `description`\nas the row subtitle when present.\n", "example": { "items": [ { "title": "Option 1", "value": "option_1", "description": "Optional WhatsApp list row subtitle" } ] } }, "campaign_id": { "type": "integer", "description": "The campaign id to which the message belongs", "example": 1 }, "template_params": { "type": "object", "description": "WhatsApp template parameters for sending structured messages", "required": [ "name", "category", "language", "processed_params" ], "properties": { "name": { "type": "string", "description": "Name of the WhatsApp template (must be approved in WhatsApp Business Manager)", "example": "purchase_receipt" }, "category": { "type": "string", "enum": [ "UTILITY", "MARKETING", "SHIPPING_UPDATE", "TICKET_UPDATE", "ISSUE_RESOLUTION" ], "description": "Category of the template", "example": "UTILITY" }, "language": { "type": "string", "description": "Language code of the template (BCP 47 format)", "example": "en_US" }, "content_mode": { "type": "string", "enum": [ "raw_template", "rendered" ], "default": "rendered", "description": "Format of the top-level `content` field. Existing clients may send rendered\ncontent or omit this field. Set this to `raw_template` only when `content`\ncontains the original template body placeholders.\n" }, "processed_params": { "type": "object", "description": "Processed template parameters organized by component type", "properties": { "body": { "type": "object", "description": "Body component parameters with variable placeholders", "additionalProperties": { "type": "string" }, "example": { "1": "Visa", "2": "Nike", "3": "Bill" } }, "header": { "type": "object", "description": "Header component parameters for media templates", "properties": { "media_url": { "type": "string", "format": "uri", "description": "Publicly accessible URL for IMAGE, VIDEO, or DOCUMENT headers", "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf" }, "media_type": { "type": "string", "enum": [ "image", "video", "document" ], "description": "Type of media for the header", "example": "document" } } }, "buttons": { "type": "array", "description": "Button component parameters for interactive templates", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url", "copy_code" ], "description": "Type of button parameter" }, "parameter": { "type": "string", "description": "Dynamic parameter value for the button", "example": "SSFSDFSD" } } } } } } } } } }, "inbox_create_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the inbox.", "example": "Support" }, "avatar": { "type": "string", "format": "binary", "description": "Image file for avatar." }, "greeting_enabled": { "type": "boolean", "description": "Enable greeting message.", "example": true }, "greeting_message": { "type": "string", "description": "Greeting message to send when greeting messages are enabled.", "example": "Hello, how can I help you?" }, "enable_email_collect": { "type": "boolean", "description": "Enable email collection.\n\nAvailable for: `Website`\n", "example": true }, "csat_survey_enabled": { "type": "boolean", "description": "Enable CSAT survey.", "example": true }, "csat_config": { "type": "object", "description": "CSAT survey configuration.", "properties": { "display_type": { "type": "string", "description": "Display style for the CSAT survey.", "enum": [ "emoji", "star" ], "example": "emoji" }, "message": { "type": "string", "description": "Message shown with the CSAT survey.", "example": "Please rate your conversation" }, "button_text": { "type": "string", "description": "Text shown on the CSAT survey button.", "example": "Please rate us" }, "language": { "type": "string", "description": "Language code for the CSAT survey.", "example": "en" }, "survey_rules": { "type": "object", "description": "Rules that decide when to show the CSAT survey.", "properties": { "operator": { "type": "string", "example": "contains" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "billing" ] } } } } }, "enable_auto_assignment": { "type": "boolean", "description": "Enable Auto Assignment.", "example": true }, "working_hours_enabled": { "type": "boolean", "description": "Enable working hours.", "example": true }, "out_of_office_message": { "type": "string", "description": "Out of office message to send outside working hours.", "example": "We are currently out of office. Please leave a message and we will get back to you." }, "timezone": { "type": "string", "description": "Timezone of the inbox.", "example": "America/New_York" }, "allow_messages_after_resolved": { "type": "boolean", "description": "Allow messages after conversation is resolved.\n\nAvailable for: `Website`\n", "example": true }, "lock_to_single_conversation": { "type": "boolean", "description": "Lock contact messages to a single active conversation.\n\nAvailable for: `API` `LINE` `Telegram` `WhatsApp` `SMS`\n", "example": true }, "portal_id": { "type": "integer", "description": "Id of the help center portal to attach to the inbox.", "example": 1 }, "sender_name_type": { "type": "string", "description": "Sender name type for outbound email replies.\n\nAvailable for: `Website` `Email`\n", "enum": [ "friendly", "professional" ], "example": "friendly" }, "business_name": { "type": "string", "description": "Business name for outbound email replies.\n\nAvailable for: `Website` `Email`\n", "example": "My Business" }, "channel": { "oneOf": [ { "$ref": "#/components/schemas/inbox_create_web_widget_channel_payload" }, { "$ref": "#/components/schemas/inbox_create_api_channel_payload" }, { "$ref": "#/components/schemas/inbox_create_email_channel_payload" }, { "$ref": "#/components/schemas/inbox_create_line_channel_payload" }, { "$ref": "#/components/schemas/inbox_create_telegram_channel_payload" }, { "$ref": "#/components/schemas/inbox_create_whatsapp_channel_payload" }, { "$ref": "#/components/schemas/inbox_create_sms_channel_payload" } ], "discriminator": { "propertyName": "type", "mapping": { "web_widget": "#/components/schemas/inbox_create_web_widget_channel_payload", "api": "#/components/schemas/inbox_create_api_channel_payload", "email": "#/components/schemas/inbox_create_email_channel_payload", "line": "#/components/schemas/inbox_create_line_channel_payload", "telegram": "#/components/schemas/inbox_create_telegram_channel_payload", "whatsapp": "#/components/schemas/inbox_create_whatsapp_channel_payload", "sms": "#/components/schemas/inbox_create_sms_channel_payload" } } } } }, "inbox_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the inbox.", "example": "Support" }, "avatar": { "type": "string", "format": "binary", "description": "Image file for avatar." }, "greeting_enabled": { "type": "boolean", "description": "Enable greeting message.", "example": true }, "greeting_message": { "type": "string", "description": "Greeting message to send when greeting messages are enabled.", "example": "Hello, how can I help you?" }, "enable_email_collect": { "type": "boolean", "description": "Enable email collection.\n\nAvailable for: `Website`\n", "example": true }, "csat_survey_enabled": { "type": "boolean", "description": "Enable CSAT survey.", "example": true }, "csat_config": { "type": "object", "description": "CSAT survey configuration.", "properties": { "display_type": { "type": "string", "description": "Display style for the CSAT survey.", "enum": [ "emoji", "star" ], "example": "emoji" }, "message": { "type": "string", "description": "Message shown with the CSAT survey.", "example": "Please rate your conversation" }, "button_text": { "type": "string", "description": "Text shown on the CSAT survey button.", "example": "Please rate us" }, "language": { "type": "string", "description": "Language code for the CSAT survey.", "example": "en" }, "survey_rules": { "type": "object", "description": "Rules that decide when to show the CSAT survey.", "properties": { "operator": { "type": "string", "example": "contains" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "billing" ] } } } } }, "enable_auto_assignment": { "type": "boolean", "description": "Enable Auto Assignment.", "example": true }, "working_hours_enabled": { "type": "boolean", "description": "Enable working hours.", "example": true }, "out_of_office_message": { "type": "string", "description": "Out of office message to send outside working hours.", "example": "We are currently out of office. Please leave a message and we will get back to you." }, "timezone": { "type": "string", "description": "Timezone of the inbox.", "example": "America/New_York" }, "allow_messages_after_resolved": { "type": "boolean", "description": "Allow messages after conversation is resolved.\n\nAvailable for: `Website`\n", "example": true }, "lock_to_single_conversation": { "type": "boolean", "description": "Lock contact messages to a single active conversation.\n\nAvailable for: `API` `LINE` `Telegram` `WhatsApp` `SMS`\n", "example": true }, "portal_id": { "type": "integer", "description": "Id of the help center portal to attach to the inbox.", "example": 1 }, "sender_name_type": { "type": "string", "description": "Sender name type for outbound email replies.\n\nAvailable for: `Website` `Email`\n", "enum": [ "friendly", "professional" ], "example": "friendly" }, "business_name": { "type": "string", "description": "Business name for outbound email replies.\n\nAvailable for: `Website` `Email`\n", "example": "My Business" }, "branded_email_layout": { "type": [ "string", "null" ], "maxLength": 262144, "description": "Liquid HTML layout for outbound email replies. Must include `{{ content_for_layout }}` and be 262,144 characters or shorter.\n\nAvailable for: `Email`\n", "example": "{{ content_for_layout }}" }, "channel": { "anyOf": [ { "$ref": "#/components/schemas/inbox_update_web_widget_channel_payload" }, { "$ref": "#/components/schemas/inbox_update_api_channel_payload" }, { "$ref": "#/components/schemas/inbox_update_email_channel_payload" }, { "$ref": "#/components/schemas/inbox_update_line_channel_payload" }, { "$ref": "#/components/schemas/inbox_update_telegram_channel_payload" }, { "$ref": "#/components/schemas/inbox_update_whatsapp_channel_payload" }, { "$ref": "#/components/schemas/inbox_update_sms_channel_payload" } ] } } }, "account_branded_email_layout_payload": { "type": "object", "properties": { "branded_email_layout": { "type": [ "string", "null" ], "maxLength": 262144, "description": "Account-scoped Liquid HTML layout for branded email replies. Maximum length is 262,144 characters. Blank or null removes the account override.", "example": "{{ content_for_layout }}" } } }, "inbox_create_web_widget_channel_payload": { "type": "object", "title": "Website channel", "required": [ "type", "website_url" ], "properties": { "type": { "type": "string", "enum": [ "web_widget" ], "example": "web_widget" }, "website_url": { "type": "string", "description": "URL at which the widget will be loaded", "example": "https://example.com" }, "welcome_title": { "type": "string", "description": "Welcome title to be displayed on the widget", "example": "Welcome to our support" }, "welcome_tagline": { "type": "string", "description": "Welcome tagline to be displayed on the widget", "example": "We are here to help you" }, "widget_color": { "type": "string", "description": "A Hex-color string used to customize the widget", "example": "#FF5733" }, "reply_time": { "type": "string", "description": "Expected reply time shown on the widget", "enum": [ "in_a_few_minutes", "in_a_few_hours", "in_a_day" ], "example": "in_a_few_minutes" }, "pre_chat_form_enabled": { "type": "boolean", "description": "Enable the pre-chat form before starting a conversation", "example": false }, "pre_chat_form_options": { "type": "object", "description": "Pre-chat form configuration", "example": { "pre_chat_message": "Share your queries or comments here.", "pre_chat_fields": [ { "field_type": "standard", "label": "Email Id", "name": "emailAddress", "type": "email", "required": true, "enabled": true } ] } }, "continuity_via_email": { "type": "boolean", "description": "Continue conversations over email when the contact leaves the website", "example": true }, "hmac_mandatory": { "type": "boolean", "description": "Require HMAC verification for contacts using the widget", "example": false }, "allowed_domains": { "type": "string", "description": "Comma-separated list of domains where the widget is allowed to load", "example": "example.com" }, "selected_feature_flags": { "type": "array", "description": "Enabled widget feature flags", "items": { "type": "string", "enum": [ "attachments", "emoji_picker", "end_conversation", "use_inbox_avatar_for_bot", "allow_mobile_webview" ] }, "example": [ "attachments", "emoji_picker", "end_conversation" ] } } }, "inbox_create_api_channel_payload": { "type": "object", "title": "API channel", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "api" ], "example": "api" }, "webhook_url": { "type": "string", "description": "Webhook URL for API channel inbox callbacks", "example": "https://example.com/webhook" }, "hmac_mandatory": { "type": "boolean", "description": "Require HMAC verification for incoming API channel messages", "example": false }, "additional_attributes": { "type": "object", "description": "Additional attributes stored on contacts created through the API channel", "example": { "source": "mobile_app" } } } }, "inbox_create_email_channel_payload": { "type": "object", "title": "Email channel", "required": [ "type", "email" ], "properties": { "type": { "type": "string", "enum": [ "email" ], "example": "email" }, "email": { "type": "string", "description": "Email address for the inbox", "example": "support@example.com" }, "imap_enabled": { "type": "boolean", "description": "Enable IMAP for inbound emails", "example": true }, "imap_login": { "type": "string", "description": "IMAP login username", "example": "support@example.com" }, "imap_password": { "type": "string", "description": "IMAP login password", "example": "your-imap-password" }, "imap_address": { "type": "string", "description": "IMAP server address", "example": "imap.example.com" }, "imap_port": { "type": "integer", "description": "IMAP server port", "example": 993 }, "imap_enable_ssl": { "type": "boolean", "description": "Enable SSL for IMAP", "example": true }, "imap_authentication": { "type": "string", "description": "IMAP authentication method", "example": "plain" }, "smtp_enabled": { "type": "boolean", "description": "Enable SMTP for outbound emails", "example": true }, "smtp_login": { "type": "string", "description": "SMTP login username", "example": "support@example.com" }, "smtp_password": { "type": "string", "description": "SMTP login password", "example": "your-smtp-password" }, "smtp_address": { "type": "string", "description": "SMTP server address", "example": "smtp.example.com" }, "smtp_port": { "type": "integer", "description": "SMTP server port", "example": 587 }, "smtp_domain": { "type": "string", "description": "SMTP HELO domain", "example": "example.com" }, "smtp_enable_starttls_auto": { "type": "boolean", "description": "Automatically enable STARTTLS for SMTP", "example": true }, "smtp_enable_ssl_tls": { "type": "boolean", "description": "Enable SSL/TLS for SMTP", "example": false }, "smtp_openssl_verify_mode": { "type": "string", "description": "OpenSSL certificate verification mode for SMTP", "example": "none" }, "smtp_authentication": { "type": "string", "description": "SMTP authentication method", "example": "login" }, "provider": { "type": "string", "description": "Email provider", "example": "google" }, "verified_for_sending": { "type": "boolean", "description": "Whether the inbox is verified for sending emails", "example": false } } }, "inbox_create_line_channel_payload": { "type": "object", "title": "LINE channel", "required": [ "type", "line_channel_id", "line_channel_secret", "line_channel_token" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "example": "line" }, "line_channel_id": { "type": "string", "description": "LINE channel ID", "example": "1234567890" }, "line_channel_secret": { "type": "string", "description": "LINE channel secret", "example": "line-channel-secret" }, "line_channel_token": { "type": "string", "description": "LINE channel access token", "example": "line-channel-token" } } }, "inbox_create_telegram_channel_payload": { "type": "object", "title": "Telegram channel", "required": [ "type", "bot_token" ], "properties": { "type": { "type": "string", "enum": [ "telegram" ], "example": "telegram" }, "bot_token": { "type": "string", "description": "Telegram bot token", "example": "123456789:telegram-bot-token" } } }, "inbox_create_whatsapp_channel_payload": { "oneOf": [ { "type": "object", "title": "WhatsApp Cloud channel", "required": [ "type", "phone_number", "provider", "provider_config" ], "properties": { "type": { "type": "string", "enum": [ "whatsapp" ], "example": "whatsapp" }, "phone_number": { "type": "string", "description": "WhatsApp phone number", "example": "+15551234567" }, "provider": { "type": "string", "description": "WhatsApp provider", "enum": [ "whatsapp_cloud" ], "example": "whatsapp_cloud" }, "provider_config": { "type": "object", "description": "WhatsApp Cloud provider configuration", "required": [ "api_key", "phone_number_id", "business_account_id" ], "properties": { "api_key": { "type": "string", "description": "WhatsApp Cloud API key", "example": "your-api-key" }, "phone_number_id": { "type": "string", "description": "Phone number ID for WhatsApp Cloud", "example": "your-phone-number-id" }, "business_account_id": { "type": "string", "description": "Business account ID for WhatsApp Cloud", "example": "your-business-account-id" } }, "example": { "api_key": "your-api-key", "phone_number_id": "your-phone-number-id", "business_account_id": "your-business-account-id" } } } }, { "type": "object", "title": "Legacy 360dialog WhatsApp channel", "deprecated": true, "required": [ "type", "phone_number", "provider_config" ], "properties": { "type": { "type": "string", "enum": [ "whatsapp" ], "example": "whatsapp" }, "phone_number": { "type": "string", "description": "WhatsApp phone number", "example": "+15551234567" }, "provider": { "type": "string", "description": "Legacy 360dialog provider. Omit this field or use `default` only for existing deprecated 360dialog setups.", "enum": [ "default" ], "deprecated": true, "example": "default" }, "provider_config": { "type": "object", "description": "Legacy 360dialog provider configuration", "required": [ "api_key" ], "properties": { "api_key": { "type": "string", "description": "360dialog API key", "example": "your-api-key" } }, "example": { "api_key": "your-api-key" } } } } ] }, "inbox_create_sms_channel_payload": { "type": "object", "title": "SMS channel", "required": [ "type", "phone_number" ], "properties": { "type": { "type": "string", "enum": [ "sms" ], "example": "sms" }, "phone_number": { "type": "string", "description": "SMS phone number", "example": "+15551234567" }, "provider_config": { "type": "object", "description": "Provider-specific SMS configuration", "example": { "account_id": "your-account-id", "application_id": "your-application-id" } } } }, "inbox_update_web_widget_channel_payload": { "type": "object", "title": "Website channel settings", "properties": { "website_url": { "type": "string", "description": "URL at which the widget will be loaded", "example": "https://example.com" }, "welcome_title": { "type": "string", "description": "Welcome title to be displayed on the widget", "example": "Welcome to our support" }, "welcome_tagline": { "type": "string", "description": "Welcome tagline to be displayed on the widget", "example": "We are here to help you" }, "widget_color": { "type": "string", "description": "A Hex-color string used to customize the widget", "example": "#FF5733" }, "reply_time": { "type": "string", "description": "Expected reply time shown on the widget", "enum": [ "in_a_few_minutes", "in_a_few_hours", "in_a_day" ], "example": "in_a_few_minutes" }, "pre_chat_form_enabled": { "type": "boolean", "description": "Enable the pre-chat form before starting a conversation", "example": false }, "pre_chat_form_options": { "type": "object", "description": "Pre-chat form configuration", "example": { "pre_chat_message": "Share your queries or comments here.", "pre_chat_fields": [ { "field_type": "standard", "label": "Email Id", "name": "emailAddress", "type": "email", "required": true, "enabled": true } ] } }, "continuity_via_email": { "type": "boolean", "description": "Continue conversations over email when the contact leaves the website", "example": true }, "hmac_mandatory": { "type": "boolean", "description": "Require HMAC verification for contacts using the widget", "example": false }, "allowed_domains": { "type": "string", "description": "Comma-separated list of domains where the widget is allowed to load", "example": "example.com" }, "selected_feature_flags": { "type": "array", "description": "Enabled widget feature flags", "items": { "type": "string", "enum": [ "attachments", "emoji_picker", "end_conversation", "use_inbox_avatar_for_bot", "allow_mobile_webview" ] }, "example": [ "attachments", "emoji_picker", "end_conversation" ] } } }, "inbox_update_api_channel_payload": { "type": "object", "title": "API channel settings", "properties": { "webhook_url": { "type": "string", "description": "Webhook URL for API channel inbox callbacks", "example": "https://example.com/webhook" }, "hmac_mandatory": { "type": "boolean", "description": "Require HMAC verification for incoming API channel messages", "example": false }, "additional_attributes": { "type": "object", "description": "Additional attributes stored on contacts created through the API channel", "example": { "source": "mobile_app" } } } }, "inbox_update_email_channel_payload": { "type": "object", "title": "Email channel settings", "properties": { "email": { "type": "string", "description": "Email address for the inbox", "example": "support@example.com" }, "imap_enabled": { "type": "boolean", "description": "Enable IMAP for inbound emails", "example": true }, "imap_login": { "type": "string", "description": "IMAP login username", "example": "support@example.com" }, "imap_password": { "type": "string", "description": "IMAP login password", "example": "your-imap-password" }, "imap_address": { "type": "string", "description": "IMAP server address", "example": "imap.example.com" }, "imap_port": { "type": "integer", "description": "IMAP server port", "example": 993 }, "imap_enable_ssl": { "type": "boolean", "description": "Enable SSL for IMAP", "example": true }, "imap_authentication": { "type": "string", "description": "IMAP authentication method", "example": "plain" }, "smtp_enabled": { "type": "boolean", "description": "Enable SMTP for outbound emails", "example": true }, "smtp_login": { "type": "string", "description": "SMTP login username", "example": "support@example.com" }, "smtp_password": { "type": "string", "description": "SMTP login password", "example": "your-smtp-password" }, "smtp_address": { "type": "string", "description": "SMTP server address", "example": "smtp.example.com" }, "smtp_port": { "type": "integer", "description": "SMTP server port", "example": 587 }, "smtp_domain": { "type": "string", "description": "SMTP HELO domain", "example": "example.com" }, "smtp_enable_starttls_auto": { "type": "boolean", "description": "Automatically enable STARTTLS for SMTP", "example": true }, "smtp_enable_ssl_tls": { "type": "boolean", "description": "Enable SSL/TLS for SMTP", "example": false }, "smtp_openssl_verify_mode": { "type": "string", "description": "OpenSSL certificate verification mode for SMTP", "example": "none" }, "smtp_authentication": { "type": "string", "description": "SMTP authentication method", "example": "login" }, "provider": { "type": "string", "description": "Email provider", "example": "google" }, "verified_for_sending": { "type": "boolean", "description": "Whether the inbox is verified for sending emails", "example": false } } }, "inbox_update_line_channel_payload": { "type": "object", "title": "LINE channel settings", "properties": { "line_channel_id": { "type": "string", "description": "LINE channel ID", "example": "1234567890" }, "line_channel_secret": { "type": "string", "description": "LINE channel secret", "example": "line-channel-secret" }, "line_channel_token": { "type": "string", "description": "LINE channel access token", "example": "line-channel-token" } } }, "inbox_update_telegram_channel_payload": { "type": "object", "title": "Telegram channel settings", "properties": { "bot_token": { "type": "string", "description": "Telegram bot token", "example": "123456789:telegram-bot-token" } } }, "inbox_update_whatsapp_channel_payload": { "type": "object", "title": "WhatsApp channel settings", "properties": { "phone_number": { "type": "string", "description": "WhatsApp phone number", "example": "+15551234567" }, "provider": { "type": "string", "description": "WhatsApp provider. `default` is supported only for existing deprecated 360dialog setups.", "enum": [ "whatsapp_cloud", "default" ], "example": "whatsapp_cloud" }, "provider_config": { "type": "object", "description": "WhatsApp provider configuration. Cloud channels use `api_key`, `phone_number_id`, and `business_account_id`; legacy 360dialog channels use `api_key`.", "properties": { "api_key": { "type": "string", "description": "Provider API key", "example": "your-api-key" }, "phone_number_id": { "type": "string", "description": "Phone number ID for WhatsApp Cloud", "example": "your-phone-number-id" }, "business_account_id": { "type": "string", "description": "Business account ID for WhatsApp Cloud", "example": "your-business-account-id" } }, "example": { "api_key": "your-api-key", "phone_number_id": "your-phone-number-id", "business_account_id": "your-business-account-id" } } } }, "inbox_update_sms_channel_payload": { "type": "object", "title": "SMS channel settings", "properties": { "phone_number": { "type": "string", "description": "SMS phone number", "example": "+15551234567" }, "provider_config": { "type": "object", "description": "Provider-specific SMS configuration", "example": { "api_key": "your-api-key", "api_secret": "your-api-secret", "application_id": "your-application-id", "account_id": "your-account-id" } } } }, "team_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the team", "example": "Support Team" }, "description": { "type": "string", "description": "The description of the team", "example": "This is a team of support agents" }, "allow_auto_assign": { "type": "boolean", "description": "If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team", "example": true } } }, "label_create_update_payload": { "type": "object", "properties": { "title": { "type": "string", "description": "The label title", "example": "support" }, "description": { "type": "string", "description": "A short description for the label", "example": "Conversations that need support follow-up" }, "color": { "type": "string", "description": "Hex color code for the label", "example": "#1f93ff" }, "show_on_sidebar": { "type": "boolean", "description": "Whether the label should appear in the sidebar", "example": true } } }, "custom_filter_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom filter", "example": "My Custom Filter" }, "type": { "type": "string", "enum": [ "conversation", "contact", "report" ], "description": "The description about the custom filter", "example": "conversation" }, "query": { "type": "object", "description": "A query that needs to be saved as a custom filter", "example": {} } } }, "webhook_create_update_payload": { "type": "object", "properties": { "url": { "type": "string", "description": "The url where the events should be sent", "example": "https://example.com/webhook" }, "name": { "type": "string", "description": "The name of the webhook" }, "subscriptions": { "type": "array", "items": { "type": "string", "enum": [ "conversation_created", "conversation_status_changed", "conversation_updated", "message_created", "message_updated", "contact_created", "contact_updated", "webwidget_triggered", "conversation_typing_on", "conversation_typing_off" ] }, "description": "The events you want to subscribe to.", "example": [ "conversation_created", "conversation_status_changed" ] } } }, "integrations_hook_create_payload": { "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of app for which integration hook is being created", "example": 1 }, "inbox_id": { "type": "integer", "description": "The inbox ID, if the hook is an inbox hook", "example": 1 }, "status": { "type": "integer", "description": "The status of the integration (0 for inactive, 1 for active)", "example": 1 }, "settings": { "type": "object", "description": "The settings required by the integration", "example": {} } } }, "integrations_hook_update_payload": { "type": "object", "properties": { "status": { "type": "integer", "description": "The status of the integration (0 for inactive, 1 for active)", "example": 1 }, "settings": { "type": "object", "description": "The settings required by the integration", "example": {} } } }, "automation_rule_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "Rule name", "example": "Add label on message create event" }, "description": { "type": "string", "description": "The description about the automation and actions", "example": "Add label support and sales on message create event if incoming message content contains text help" }, "event_name": { "type": "string", "enum": [ "conversation_created", "conversation_updated", "conversation_resolved", "message_created" ], "example": "message_created", "description": "The event when you want to execute the automation actions" }, "active": { "type": "boolean", "description": "Enable/disable automation rule" }, "actions": { "type": "array", "description": "Array of actions which you want to perform when condition matches, e.g add label support if message contains content help.", "items": { "type": "object", "example": { "action_name": "add_label", "action_params": [ "support" ] } } }, "conditions": { "type": "array", "description": "Array of conditions on which conversation filter would work, e.g message content contains text help.", "items": { "type": "object", "example": { "attribute_key": "content", "filter_operator": "contains", "query_operator": "OR", "values": [ "help" ] } } } } }, "portal_create_update_payload": { "type": "object", "properties": { "color": { "type": "string", "description": "Header color for help-center in hex format", "example": "#FFFFFF" }, "custom_domain": { "type": "string", "description": "Custom domain to display help center.", "example": "chatwoot.help" }, "header_text": { "type": "string", "description": "Help center header", "example": "Handbook" }, "homepage_link": { "type": "string", "description": "link to main dashboard", "example": "https://www.chatwoot.com/" }, "name": { "type": "string", "description": "Name for the portal", "example": "Handbook" }, "page_title": { "type": "string", "description": "Page title for the portal", "example": "Handbook" }, "slug": { "type": "string", "description": "Slug for the portal to display in link", "example": "handbook" }, "archived": { "type": "boolean", "description": "Status to check if portal is live", "example": false }, "config": { "type": "object", "description": "Configuration about supporting locales", "example": { "allowed_locales": [ "en", "es" ], "default_locale": "en" } } } }, "category_create_update_payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the category", "example": "Category Name" }, "description": { "type": "string", "description": "A description for the category", "example": "Category description" }, "position": { "type": "integer", "description": "Category position in the portal list to sort", "example": 1 }, "slug": { "type": "string", "description": "The category slug used in the URL", "example": "category-name" }, "locale": { "type": "string", "description": "The locale of the category", "example": "en" }, "icon": { "type": "string", "description": "The icon of the category as a string (emoji)", "example": "📚" }, "parent_category_id": { "type": "integer", "description": "To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.", "example": 1 }, "associated_category_id": { "type": "integer", "description": "To associate similar categories to each other, e.g same category of product documentation in different languages", "example": 2 } } }, "article_create_update_payload": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the article", "example": "Article Title" }, "slug": { "type": "string", "description": "The slug of the article", "example": "article-title" }, "position": { "type": "integer", "description": "article position in category", "example": 1 }, "content": { "type": "string", "description": "The text content.", "example": "This is the content of the article" }, "description": { "type": "string", "description": "The description of the article", "example": "This is the description of the article" }, "category_id": { "type": "integer", "description": "The category id of the article", "example": 1 }, "author_id": { "type": "integer", "description": "The author agent id of the article", "example": 1 }, "associated_article_id": { "type": "integer", "description": "To associate similar articles to each other, e.g to provide the link for the reference.", "example": 2 }, "status": { "type": "integer", "description": "The status of the article. 0 for draft, 1 for published, 2 for archived", "example": 1 }, "locale": { "type": "string", "description": "The locale of the article", "example": "en" }, "meta": { "type": "object", "description": "Use for search", "example": { "tags": [ "article_name" ], "title": "article title", "description": "article description" } } } }, "public_contact_create_update_payload": { "type": "object", "properties": { "identifier": { "type": "string", "description": "External identifier of the contact", "example": "1234567890" }, "identifier_hash": { "type": "string", "description": "Identifier hash prepared for HMAC authentication", "example": "e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9" }, "email": { "type": "string", "description": "Email of the contact", "example": "alice@acme.inc" }, "name": { "type": "string", "description": "Name of the contact", "example": "Alice" }, "phone_number": { "type": "string", "description": "Phone number of the contact", "example": "+123456789" }, "avatar": { "type": "string", "format": "binary", "description": "Send the form data with the avatar image binary or use the avatar_url" }, "custom_attributes": { "type": "object", "description": "Custom attributes of the customer", "example": {} } } }, "public_message_create_payload": { "type": "object", "properties": { "content": { "type": "string", "description": "Content for the message", "example": "Hello, how can I help you?" }, "echo_id": { "type": "string", "description": "Temporary identifier which will be passed back via websockets", "example": "1234567890" } } }, "public_message_update_payload": { "type": "object", "properties": { "submitted_values": { "type": "object", "description": "Replies to the Bot Message Types", "properties": { "name": { "type": "string", "description": "The name of the submiitted value", "example": "My Name" }, "title": { "type": "string", "description": "The title of the submitted value", "example": "My Title" }, "value": { "type": "string", "description": "The value of the submitted value", "example": "value" }, "csat_survey_response": { "type": "object", "description": "The CSAT survey response", "properties": { "feedback_message": { "type": "string", "description": "The feedback message of the CSAT survey response", "example": "Great service!" }, "rating": { "type": "integer", "description": "The rating of the CSAT survey response", "example": 5 } } } } } } }, "public_conversation_create_payload": { "type": "object", "properties": { "custom_attributes": { "type": "object", "description": "Custom attributes of the conversation", "example": {} } } }, "extended_contact": { "allOf": [ { "$ref": "#/components/schemas/contact" }, { "type": "object", "properties": { "id": { "type": "number", "description": "Id of the user" }, "availability_status": { "type": "string", "enum": [ "online", "offline" ], "description": "Availability status of the user" } } } ] }, "contact_base": { "allOf": [ { "$ref": "#/components/schemas/generic_id" }, { "$ref": "#/components/schemas/contact" } ] }, "contact_list": { "type": "array", "description": "array of contacts", "items": { "allOf": [ { "$ref": "#/components/schemas/contact" } ] } }, "contact_conversations": { "type": "array", "description": "array of conversations", "items": { "allOf": [ { "$ref": "#/components/schemas/conversation" }, { "type": "object", "properties": { "meta": { "type": "object", "properties": { "sender": { "type": "object", "properties": { "additional_attributes": { "type": "object", "description": "The additional attributes of the sender" }, "availability_status": { "type": "string", "description": "The availability status of the sender" }, "email": { "type": [ "string", "null" ], "description": "The email of the sender" }, "id": { "type": "number", "description": "ID fo the sender" }, "name": { "type": "string", "description": "The name of the sender" }, "phone_number": { "type": [ "string", "null" ], "description": "The phone number of the sender" }, "blocked": { "type": "boolean", "description": "Whether the sender is blocked" }, "identifier": { "type": [ "string", "null" ], "description": "The identifier of the sender" }, "thumbnail": { "type": [ "string", "null" ], "description": "Avatar URL of the contact" }, "custom_attributes": { "type": "object", "description": "The custom attributes of the sender" }, "last_activity_at": { "type": "number", "description": "The last activity at of the sender" }, "created_at": { "type": "number", "description": "The created at of the sender" } } }, "channel": { "type": "string", "description": "Channel Type" }, "assignee": { "$ref": "#/components/schemas/user" }, "hmac_verified": { "type": "boolean", "description": "Whether the hmac is verified" } } } } }, { "type": "object", "properties": { "display_id": { "type": "number" } } } ] } }, "contact_labels": { "type": "object", "properties": { "payload": { "type": "array", "description": "Array of labels", "items": { "type": "string" } } } }, "conversation_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "mine_count": { "type": "number" }, "unassigned_count": { "type": "number" }, "assigned_count": { "type": "number" }, "all_count": { "type": "number" } } }, "payload": { "type": "array", "description": "array of conversations", "items": { "allOf": [ { "$ref": "#/components/schemas/generic_id" }, { "$ref": "#/components/schemas/conversation" }, { "type": "object", "properties": { "meta": { "type": "object", "properties": { "sender": { "type": "object", "properties": { "additional_attributes": { "type": "object", "description": "The additional attributes of the sender" }, "availability_status": { "type": "string", "description": "The availability status of the sender" }, "email": { "type": [ "string", "null" ], "description": "The email of the sender" }, "id": { "type": "number", "description": "ID fo the sender" }, "name": { "type": "string", "description": "The name of the sender" }, "phone_number": { "type": [ "string", "null" ], "description": "The phone number of the sender" }, "blocked": { "type": "boolean", "description": "Whether the sender is blocked" }, "identifier": { "type": [ "string", "null" ], "description": "The identifier of the sender" }, "thumbnail": { "type": [ "string", "null" ], "description": "Avatar URL of the contact" }, "custom_attributes": { "type": "object", "description": "The custom attributes of the sender" }, "last_activity_at": { "type": "number", "description": "The last activity at of the sender" }, "created_at": { "type": "number", "description": "The created at of the sender" } } }, "channel": { "type": "string", "description": "Channel Type" }, "assignee": { "$ref": "#/components/schemas/user" }, "hmac_verified": { "type": "boolean", "description": "Whether the hmac is verified" } } } } } ] } } } } } }, "conversation_show": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/conversation" }, { "type": "object", "properties": { "meta": { "type": "object", "properties": { "sender": { "type": "object", "properties": { "additional_attributes": { "type": "object", "description": "The additional attributes of the sender" }, "availability_status": { "type": "string", "description": "The availability status of the sender" }, "email": { "type": [ "string", "null" ], "description": "The email of the sender" }, "id": { "type": "number", "description": "ID fo the sender" }, "name": { "type": "string", "description": "The name of the sender" }, "phone_number": { "type": [ "string", "null" ], "description": "The phone number of the sender" }, "blocked": { "type": "boolean", "description": "Whether the sender is blocked" }, "identifier": { "type": [ "string", "null" ], "description": "The identifier of the sender" }, "thumbnail": { "type": [ "string", "null" ], "description": "Avatar URL of the contact" }, "custom_attributes": { "type": "object", "description": "The custom attributes of the sender" }, "last_activity_at": { "type": "number", "description": "The last activity at of the sender" }, "created_at": { "type": "number", "description": "The created at of the sender" } } }, "channel": { "type": "string", "description": "Channel Type" }, "assignee": { "$ref": "#/components/schemas/user" }, "hmac_verified": { "type": "boolean", "description": "Whether the hmac is verified" } } } } } ] }, "conversation_status_toggle": { "type": "object", "properties": { "meta": { "type": "object" }, "payload": { "type": "object", "properties": { "success": { "type": "boolean" }, "current_status": { "type": "string", "enum": [ "open", "resolved" ] }, "conversation_id": { "type": "number" } } } } }, "conversation_labels": { "type": "object", "properties": { "payload": { "type": "array", "description": "Array of labels", "items": { "type": "string" } } } }, "account_summary": { "type": "object", "properties": { "avg_first_response_time": { "type": "string" }, "avg_resolution_time": { "type": "string" }, "conversations_count": { "type": "number" }, "incoming_messages_count": { "type": "number" }, "outgoing_messages_count": { "type": "number" }, "resolutions_count": { "type": "number" }, "previous": { "type": "object", "properties": { "avg_first_response_time": { "type": "string" }, "avg_resolution_time": { "type": "string" }, "conversations_count": { "type": "number" }, "incoming_messages_count": { "type": "number" }, "outgoing_messages_count": { "type": "number" }, "resolutions_count": { "type": "number" } } } } }, "agent_conversation_metrics": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "thumbnail": { "type": "string" }, "availability": { "type": "string" }, "metric": { "type": "object", "properties": { "open": { "type": "number" }, "unattended": { "type": "number" } } } } }, "channel_summary": { "type": "object", "description": "Channel summary report containing conversation counts grouped by channel type and status. Available in version 4.10.0+.", "additionalProperties": { "type": "object", "description": "Conversation statistics for a specific channel type (e.g., Channel::WebWidget, Channel::Api)", "properties": { "open": { "type": "number", "description": "Number of open conversations" }, "resolved": { "type": "number", "description": "Number of resolved conversations" }, "pending": { "type": "number", "description": "Number of pending conversations" }, "snoozed": { "type": "number", "description": "Number of snoozed conversations" }, "total": { "type": "number", "description": "Total number of conversations" } } }, "example": { "Channel::WebWidget": { "open": 10, "resolved": 20, "pending": 5, "snoozed": 2, "total": 37 }, "Channel::Api": { "open": 5, "resolved": 15, "pending": 3, "snoozed": 1, "total": 24 } } }, "first_response_time_distribution": { "type": "object", "description": "First response time distribution report grouped by channel type. Shows the count of conversations with first response times in different time buckets.", "additionalProperties": { "type": "object", "description": "First response time distribution for a specific channel type (e.g., Channel::WebWidget, Channel::Api)", "properties": { "0-1h": { "type": "number", "description": "Number of conversations with first response time less than 1 hour" }, "1-4h": { "type": "number", "description": "Number of conversations with first response time between 1-4 hours" }, "4-8h": { "type": "number", "description": "Number of conversations with first response time between 4-8 hours" }, "8-24h": { "type": "number", "description": "Number of conversations with first response time between 8-24 hours" }, "24h+": { "type": "number", "description": "Number of conversations with first response time greater than 24 hours" } } }, "example": { "Channel::WebWidget": { "0-1h": 150, "1-4h": 80, "4-8h": 45, "8-24h": 30, "24h+": 15 }, "Channel::Api": { "0-1h": 75, "1-4h": 40, "4-8h": 20, "8-24h": 10, "24h+": 5 } } }, "inbox_label_matrix": { "type": "object", "description": "Inbox-label matrix report showing the count of conversations for each inbox-label combination.", "properties": { "inboxes": { "type": "array", "description": "List of inboxes included in the report", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "The inbox ID" }, "name": { "type": "string", "description": "The inbox name" } } } }, "labels": { "type": "array", "description": "List of labels included in the report", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "The label ID" }, "title": { "type": "string", "description": "The label title" } } } }, "matrix": { "type": "array", "description": "2D array where matrix[i][j] represents the count of conversations in inboxes[i] with labels[j]", "items": { "type": "array", "items": { "type": "number" } } } }, "example": { "inboxes": [ { "id": 1, "name": "Website Chat" }, { "id": 2, "name": "Email Support" } ], "labels": [ { "id": 1, "title": "bug" }, { "id": 2, "title": "feature-request" }, { "id": 3, "title": "urgent" } ], "matrix": [ [ 10, 5, 3 ], [ 8, 12, 2 ] ] } }, "outgoing_messages_count": { "type": "array", "description": "Outgoing messages count report grouped by entity (agent, team, inbox, or label).", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the grouped entity (agent, team, inbox, or label)." }, "name": { "type": "string", "description": "The name of the grouped entity." }, "outgoing_messages_count": { "type": "number", "description": "The total number of outgoing messages for this entity in the given time range." } } }, "example": [ { "id": 1, "name": "Agent One", "outgoing_messages_count": 42 }, { "id": 2, "name": "Agent Two", "outgoing_messages_count": 18 } ] }, "inbox_summary": { "type": "array", "description": "Inbox summary report containing conversation statistics grouped by inbox.", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "The inbox ID" }, "conversations_count": { "type": "number", "description": "Number of conversations created in the inbox during the date range" }, "resolved_conversations_count": { "type": "number", "description": "Number of conversations resolved in the inbox during the date range" }, "avg_resolution_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) to resolve conversations. Null if no data available." }, "avg_first_response_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) for the first response. Null if no data available." }, "avg_reply_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) between replies. Null if no data available." } } }, "example": [ { "id": 1, "conversations_count": 150, "resolved_conversations_count": 120, "avg_resolution_time": 3600, "avg_first_response_time": 300, "avg_reply_time": 600 }, { "id": 2, "conversations_count": 75, "resolved_conversations_count": 60, "avg_resolution_time": 1800, "avg_first_response_time": 180, "avg_reply_time": 420 } ] }, "agent_summary": { "type": "array", "description": "Agent summary report containing conversation statistics grouped by agent.", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "The agent (user) ID" }, "conversations_count": { "type": "number", "description": "Number of conversations assigned to the agent during the date range" }, "resolved_conversations_count": { "type": "number", "description": "Number of conversations resolved by the agent during the date range" }, "avg_resolution_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) to resolve conversations. Null if no data available." }, "avg_first_response_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) for the first response. Null if no data available." }, "avg_reply_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) between replies. Null if no data available." } } }, "example": [ { "id": 1, "conversations_count": 150, "resolved_conversations_count": 120, "avg_resolution_time": 3600, "avg_first_response_time": 300, "avg_reply_time": 600 }, { "id": 2, "conversations_count": 75, "resolved_conversations_count": 60, "avg_resolution_time": 1800, "avg_first_response_time": 180, "avg_reply_time": 420 } ] }, "team_summary": { "type": "array", "description": "Team summary report containing conversation statistics grouped by team.", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "The team ID" }, "conversations_count": { "type": "number", "description": "Number of conversations assigned to the team during the date range" }, "resolved_conversations_count": { "type": "number", "description": "Number of conversations resolved by the team during the date range" }, "avg_resolution_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) to resolve conversations. Null if no data available." }, "avg_first_response_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) for the first response. Null if no data available." }, "avg_reply_time": { "type": [ "number", "null" ], "description": "Average time (in seconds) between replies. Null if no data available." } } }, "example": [ { "id": 1, "conversations_count": 250, "resolved_conversations_count": 200, "avg_resolution_time": 2800, "avg_first_response_time": 240, "avg_reply_time": 500 }, { "id": 2, "conversations_count": 180, "resolved_conversations_count": 150, "avg_resolution_time": 2400, "avg_first_response_time": 200, "avg_reply_time": 450 } ] }, "contact_detail": { "type": "object", "properties": { "additional_attributes": { "type": "object", "description": "The object containing additional attributes related to the contact", "properties": { "city": { "type": "string", "description": "City of the contact" }, "country": { "type": "string", "description": "Country of the contact" }, "country_code": { "type": [ "string", "null" ], "description": "Country code of the contact" }, "created_at_ip": { "type": "string", "description": "IP address when the contact was created" } } }, "custom_attributes": { "type": "object", "description": "The custom attributes of the contact" }, "email": { "type": "string", "description": "The email address of the contact" }, "id": { "type": "integer", "description": "The ID of the contact" }, "identifier": { "type": [ "string", "null" ], "description": "The identifier of the contact" }, "name": { "type": "string", "description": "The name of the contact" }, "phone_number": { "type": [ "string", "null" ], "description": "The phone number of the contact" }, "thumbnail": { "type": "string", "description": "The thumbnail of the contact" }, "blocked": { "type": "boolean", "description": "Whether the contact is blocked" }, "type": { "type": "string", "description": "The type of entity", "enum": [ "contact" ] } } }, "message_detailed": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the message" }, "content": { "type": "string", "description": "The text content of the message" }, "inbox_id": { "type": "number", "description": "The ID of the inbox" }, "conversation_id": { "type": "number", "description": "The ID of the conversation" }, "message_type": { "type": "integer", "enum": [ 0, 1, 2, 3 ], "description": "The type of the message (0: incoming, 1: outgoing, 2: activity, 3: template)" }, "content_type": { "type": "string", "enum": [ "text", "input_text", "input_textarea", "input_email", "input_select", "cards", "form", "article", "incoming_email", "input_csat", "integrations", "sticker", "voice_call" ], "description": "The type of the message content" }, "status": { "type": "string", "enum": [ "sent", "delivered", "read", "failed" ], "description": "The status of the message" }, "content_attributes": { "type": "object", "description": "The content attributes for each content_type", "properties": { "in_reply_to": { "type": [ "string", "null" ], "description": "ID of the message this is replying to" } } }, "echo_id": { "type": [ "string", "null" ], "description": "The echo ID of the message, used for deduplication" }, "created_at": { "type": "integer", "description": "The timestamp when message was created" }, "private": { "type": "boolean", "description": "The flag which shows whether the message is private or not" }, "source_id": { "type": [ "string", "null" ], "description": "The source ID of the message" }, "sender": { "$ref": "#/components/schemas/contact_detail" }, "attachments": { "type": "array", "description": "The list of attachments associated with the message", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the attachment" }, "message_id": { "type": "number", "description": "The ID of the message" }, "file_type": { "type": "string", "enum": [ "image", "video", "audio", "file", "location", "fallback", "share", "story_mention", "contact", "ig_reel" ], "description": "The type of the attached file" }, "account_id": { "type": "number", "description": "The ID of the account" }, "data_url": { "type": "string", "description": "The URL of the attached file" }, "thumb_url": { "type": "string", "description": "The thumbnail URL of the attached file" }, "file_size": { "type": "number", "description": "The size of the attached file in bytes" } } } } } }, "conversation_meta": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" }, "description": "Labels associated with the conversation" }, "additional_attributes": { "type": "object", "properties": { "browser": { "type": "object", "properties": { "device_name": { "type": "string", "description": "Name of the device" }, "browser_name": { "type": "string", "description": "Name of the browser" }, "platform_name": { "type": "string", "description": "Name of the platform" }, "browser_version": { "type": "string", "description": "Version of the browser" }, "platform_version": { "type": "string", "description": "Version of the platform" } } }, "referer": { "type": "string", "description": "Referrer URL" }, "initiated_at": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Timestamp when the conversation was initiated" } } }, "browser_language": { "type": "string", "description": "Browser language setting" }, "conversation_language": { "type": "string", "description": "Conversation language" } }, "description": "Additional attributes of the conversation" }, "contact": { "$ref": "#/components/schemas/contact_detail" }, "assignee": { "allOf": [ { "$ref": "#/components/schemas/agent" } ], "description": "The agent assigned to the conversation", "nullable": true }, "agent_last_seen_at": { "type": [ "string", "null" ], "description": "Timestamp when the agent last saw the conversation" }, "assignee_last_seen_at": { "type": [ "string", "null" ], "description": "Timestamp when the assignee last saw the conversation" } } }, "conversation_messages": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/conversation_meta" }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/message_detailed" }, "description": "List of messages in the conversation" } } }, "contact_meta": { "type": "object", "properties": { "count": { "type": "integer", "description": "Total number of contacts" }, "current_page": { "type": [ "string", "integer" ], "description": "Current page number" } } }, "contact_inbox": { "type": "object", "properties": { "source_id": { "type": "string", "description": "Source identifier for the contact inbox" }, "inbox": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the inbox" }, "avatar_url": { "type": "string", "description": "URL for the inbox avatar" }, "channel_id": { "type": "integer", "description": "ID of the channel" }, "name": { "type": "string", "description": "Name of the inbox" }, "channel_type": { "type": "string", "description": "Type of channel" }, "provider": { "type": [ "string", "null" ], "description": "Provider of the inbox" } } } } }, "contact_list_item": { "type": "object", "properties": { "additional_attributes": { "type": "object", "description": "The object containing additional attributes related to the contact", "properties": { "city": { "type": "string", "description": "City of the contact" }, "country": { "type": "string", "description": "Country of the contact" }, "country_code": { "type": [ "string", "null" ], "description": "Country code of the contact" }, "created_at_ip": { "type": "string", "description": "IP address when the contact was created" } } }, "availability_status": { "type": "string", "description": "Availability status of the contact", "enum": [ "online", "offline" ] }, "email": { "type": [ "string", "null" ], "description": "The email address of the contact" }, "id": { "type": "integer", "description": "The ID of the contact" }, "name": { "type": "string", "description": "The name of the contact" }, "phone_number": { "type": [ "string", "null" ], "description": "The phone number of the contact" }, "blocked": { "type": "boolean", "description": "Whether the contact is blocked" }, "identifier": { "type": [ "string", "null" ], "description": "The identifier of the contact" }, "thumbnail": { "type": "string", "description": "The thumbnail of the contact" }, "custom_attributes": { "type": "object", "description": "The custom attributes of the contact" }, "last_activity_at": { "type": [ "integer", "null" ], "description": "Timestamp of last activity" }, "created_at": { "type": "integer", "description": "Timestamp when contact was created" }, "contact_inboxes": { "type": "array", "description": "List of inboxes associated with this contact", "items": { "$ref": "#/components/schemas/contact_inbox" } } } }, "contacts_list_response": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/contact_meta" }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/contact_list_item" }, "description": "List of contacts" } } }, "contact_show_response": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/contact_list_item" } } }, "contact_conversation_message": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the message" }, "content": { "type": "string", "description": "Content of the message" }, "account_id": { "type": "integer", "description": "ID of the account" }, "inbox_id": { "type": "integer", "description": "ID of the inbox" }, "conversation_id": { "type": "integer", "description": "ID of the conversation" }, "message_type": { "type": "integer", "description": "Type of the message" }, "created_at": { "type": "integer", "description": "Timestamp when message was created" }, "updated_at": { "type": "string", "description": "Formatted datetime when message was updated" }, "private": { "type": "boolean", "description": "Whether the message is private" }, "status": { "type": "string", "description": "Status of the message" }, "source_id": { "type": [ "string", "null" ], "description": "Source ID of the message" }, "content_type": { "type": "string", "description": "Type of the content" }, "content_attributes": { "type": "object", "description": "Attributes of the content" }, "sender_type": { "type": [ "string", "null" ], "description": "Type of the sender" }, "sender_id": { "type": [ "integer", "null" ], "description": "ID of the sender" }, "external_source_ids": { "type": "object", "description": "External source IDs" }, "additional_attributes": { "type": "object", "description": "Additional attributes of the message" }, "processed_message_content": { "type": [ "string", "null" ], "description": "Processed message content" }, "sentiment": { "type": "object", "description": "Sentiment analysis of the message" }, "conversation": { "type": "object", "description": "Conversation details", "properties": { "assignee_id": { "type": [ "integer", "null" ], "description": "ID of the assignee" }, "unread_count": { "type": "integer", "description": "Count of unread messages" }, "last_activity_at": { "type": "integer", "description": "Timestamp of last activity" }, "contact_inbox": { "type": "object", "description": "Contact inbox details", "properties": { "source_id": { "type": "string", "description": "Source ID of the contact inbox" } } } } }, "sender": { "type": "object", "description": "Details of the sender", "properties": { "id": { "type": "integer", "description": "ID of the sender" }, "name": { "type": "string", "description": "Name of the sender" }, "available_name": { "type": "string", "description": "Available name of the sender" }, "avatar_url": { "type": "string", "description": "URL of the sender's avatar" }, "type": { "type": "string", "description": "Type of the sender" }, "availability_status": { "type": "string", "description": "Availability status of the sender" }, "thumbnail": { "type": "string", "description": "Thumbnail URL of the sender" } } } } }, "contact_conversations_response": { "type": "object", "properties": { "payload": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/conversation" }, { "type": "object", "properties": { "meta": { "type": "object", "properties": { "sender": { "type": "object", "properties": { "additional_attributes": { "type": "object", "description": "The additional attributes of the sender" }, "availability_status": { "type": "string", "description": "The availability status of the sender" }, "email": { "type": [ "string", "null" ], "description": "The email of the sender" }, "id": { "type": "number", "description": "ID fo the sender" }, "name": { "type": "string", "description": "The name of the sender" }, "phone_number": { "type": [ "string", "null" ], "description": "The phone number of the sender" }, "blocked": { "type": "boolean", "description": "Whether the sender is blocked" }, "identifier": { "type": [ "string", "null" ], "description": "The identifier of the sender" }, "thumbnail": { "type": [ "string", "null" ], "description": "Avatar URL of the contact" }, "custom_attributes": { "type": "object", "description": "The custom attributes of the sender" }, "last_activity_at": { "type": "number", "description": "The last activity at of the sender" }, "created_at": { "type": "number", "description": "The created at of the sender" } } }, "channel": { "type": "string", "description": "Channel Type" }, "assignee": { "$ref": "#/components/schemas/user" }, "hmac_verified": { "type": "boolean", "description": "Whether the hmac is verified" } } } } } ] }, "description": "List of conversations for the contact" } } }, "contactable_inboxes_response": { "type": "object", "properties": { "payload": { "type": "array", "items": { "$ref": "#/components/schemas/contact_inbox" }, "description": "List of contactable inboxes for the contact" } } }, "reporting_event": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the reporting event" }, "name": { "type": "string", "description": "Name of the event (e.g., first_response, resolution, reply_time)" }, "value": { "type": "number", "format": "double", "description": "Value of the metric in seconds" }, "value_in_business_hours": { "type": "number", "format": "double", "description": "Value of the metric in seconds, calculated only for business hours" }, "event_start_time": { "type": "string", "format": "date-time", "description": "The timestamp when the event started" }, "event_end_time": { "type": "string", "format": "date-time", "description": "The timestamp when the event ended" }, "account_id": { "type": "number", "description": "ID of the account" }, "conversation_id": { "type": [ "number", "null" ], "description": "ID of the conversation" }, "inbox_id": { "type": [ "number", "null" ], "description": "ID of the inbox" }, "user_id": { "type": [ "number", "null" ], "description": "ID of the user/agent" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the reporting event was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the reporting event was last updated" } } }, "reporting_event_meta": { "type": "object", "properties": { "count": { "type": "integer", "description": "Total number of reporting events" }, "current_page": { "type": "integer", "description": "Current page number" }, "total_pages": { "type": "integer", "description": "Total number of pages" } } }, "reporting_events_list_response": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/reporting_event_meta" }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/reporting_event" }, "description": "List of reporting events" } } }, "campaign": { "type": "object", "properties": { "id": { "type": "integer", "description": "Account-scoped campaign ID. Use this value in campaign API paths." }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "account_id": { "type": "integer" }, "inbox": { "$ref": "#/components/schemas/inbox" }, "sender": { "type": "object", "description": "Sender details, or an empty object when no sender is assigned.", "additionalProperties": true }, "message": { "type": "string" }, "template_params": { "type": [ "object", "null" ], "additionalProperties": true }, "campaign_status": { "type": "string", "enum": [ "active", "processing", "completed" ] }, "campaign_type": { "type": "string", "enum": [ "ongoing", "one_off" ], "description": "Derived from the inbox type; website campaigns are ongoing and supported messaging campaigns are one-off." }, "enabled": { "type": "boolean" }, "scheduled_at": { "type": "integer", "description": "Scheduled time in Unix seconds. Only present for one-off campaigns." }, "started_at": { "type": [ "integer", "null" ], "description": "Start time in Unix seconds. Only present for one-off campaigns." }, "completed_at": { "type": [ "integer", "null" ], "description": "Completion time in Unix seconds. Only present for one-off campaigns." }, "audience": { "type": [ "array", "null" ], "description": "Audience for a one-off campaign. Only present for one-off campaigns.", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "integer" } } } }, "trigger_rules": { "type": "object", "additionalProperties": true }, "trigger_only_during_business_hours": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "campaign_fields": { "type": "object", "properties": { "title": { "type": "string", "description": "Campaign title." }, "description": { "type": [ "string", "null" ], "description": "Internal description of the campaign." }, "inbox_id": { "type": "integer", "description": "ID of an inbox in this account. Supported inbox types are Website, Twilio SMS, SMS, and WhatsApp." }, "sender_id": { "type": [ "integer", "null" ], "description": "ID of a user in this account to use as the campaign sender." }, "message": { "type": "string", "description": "Campaign message content." }, "enabled": { "type": "boolean", "description": "Whether an ongoing website campaign is enabled. This does not cancel a scheduled one-off campaign." }, "scheduled_at": { "type": "string", "format": "date-time", "description": "Scheduled time for a one-off campaign, as an ISO 8601 timestamp with timezone. Defaults to the current time when omitted; website campaigns ignore this field. Responses return Unix seconds instead.", "example": "2027-01-15T10:00:00Z" }, "audience": { "type": "array", "minItems": 1, "description": "Required when creating a one-off SMS or WhatsApp campaign. Provide at least one label from this account. Contacts matching any selected label are included. When updating, omit this field to retain the existing audience.", "items": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "Label" ] }, "id": { "type": "integer", "description": "ID of a label in this account." } } } }, "trigger_rules": { "type": "object", "additionalProperties": true, "description": "Website campaign trigger rules. Defaults to an empty object and can be omitted for a one-off campaign.", "example": { "url": "https://example.com/pricing", "time_on_page": 10 } }, "trigger_only_during_business_hours": { "type": "boolean", "description": "Restrict an ongoing website campaign to inbox business hours." }, "template_params": { "$ref": "#/components/schemas/campaign_whatsapp_template_params" } } }, "campaign_create_payload": { "type": "object", "required": [ "campaign" ], "properties": { "campaign": { "description": "Choose the variant matching the inbox referenced by inbox_id. The channel type is stored on the inbox and cannot be inferred from this request by a schema validator. These variants describe the inputs needed for delivery; creation can accept incomplete inputs without guaranteeing that the campaign will send.", "allOf": [ { "$ref": "#/components/schemas/campaign_fields" }, { "type": "object", "required": [ "title", "inbox_id", "message" ] }, { "anyOf": [ { "title": "Website campaign", "description": "For a Website inbox, supply URL trigger rules. An audience is not required.", "type": "object", "required": [ "trigger_rules" ], "properties": { "trigger_rules": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" } } } } }, { "title": "SMS campaign", "description": "For an SMS or Twilio SMS inbox, supply at least one audience label.", "type": "object", "required": [ "audience" ] }, { "title": "WhatsApp campaign", "description": "For a WhatsApp Cloud inbox with campaigns enabled, supply audience labels and template parameters.", "type": "object", "required": [ "audience", "template_params" ] } ] } ] } } }, "campaign_update_payload": { "type": "object", "required": [ "campaign" ], "properties": { "campaign": { "allOf": [ { "$ref": "#/components/schemas/campaign_fields" } ] } } }, "campaign_whatsapp_template_params": { "type": "object", "required": [ "name", "language" ], "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of the approved template in the selected inbox's message_templates." }, "language": { "type": "string", "minLength": 1, "description": "Language code matching that template in the selected inbox.", "example": "en" }, "namespace": { "type": "string", "description": "Template namespace, when present in the selected template." }, "category": { "type": "string", "description": "Category of the selected template." }, "processed_params": { "type": "object", "description": "Values for the selected template's variables, grouped by component. Supply all parameters needed by that template. May be omitted for a template without variables. Body keys use positional numbers or the template's named parameters. Liquid expressions such as {{ contact.name }} are rendered separately for each recipient.", "properties": { "body": { "type": "object", "additionalProperties": { "type": "string" } }, "header": { "type": "object", "additionalProperties": true, "description": "Text parameter values or media_url, media_type, and optional media_name for a media header." }, "footer": { "type": "object", "additionalProperties": { "type": "string" } }, "buttons": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "example": { "body": { "1": "{{ contact.name }}" } } } } } }, "parameters": { "account_id": { "in": "path", "name": "account_id", "schema": { "type": "integer" }, "required": true, "description": "The numeric ID of the account" }, "agent_bot_id": { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true, "description": "The ID of the agentbot to be updated" }, "team_id": { "in": "path", "name": "team_id", "schema": { "type": "integer" }, "required": true, "description": "The ID of the team to be updated" }, "inbox_id": { "in": "path", "name": "inbox_id", "schema": { "type": "integer" }, "required": true, "description": "The ID of the Inbox" }, "hook_id": { "in": "path", "name": "hook_id", "schema": { "type": "integer" }, "required": true, "description": "The numeric ID of the integration hook" }, "source_id": { "in": "path", "name": "source_id", "required": true, "schema": { "type": "string" }, "description": "Id of the session for which the conversation is created.\n\n\n\n Source Ids can be obtained through contactable inboxes API or via generated.

Website: Chatwoot generated string which can be obtained from webhook events.
Phone Channels(Twilio): Phone number in e164 format
Email Channels: Contact Email address
API Channel: Any Random String" }, "contact_sort_param": { "in": "query", "name": "sort", "schema": { "type": "string", "enum": [ "name", "email", "phone_number", "last_activity_at", "-name", "-email", "-phone_number", "-last_activity_at" ] }, "required": false, "description": "The attribute by which list should be sorted" }, "conversation_id": { "in": "path", "name": "conversation_id", "schema": { "type": "integer" }, "required": true, "description": "The numeric ID of the conversation" }, "conversation_uuid": { "in": "path", "name": "conversation_uuid", "schema": { "type": "integer" }, "required": true, "description": "The uuid of the conversation" }, "custom_filter_id": { "in": "path", "name": "custom_filter_id", "schema": { "type": "integer" }, "required": true, "description": "The numeric ID of the custom filter" }, "webhook_id": { "in": "path", "name": "webhook_id", "schema": { "type": "integer" }, "required": true, "description": "The numeric ID of the webhook" }, "message_id": { "in": "path", "name": "message_id", "schema": { "type": "integer" }, "required": true, "description": "The numeric ID of the message" }, "page": { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "required": false, "description": "The page parameter" }, "platform_user_id": { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true, "description": "The numeric ID of the user on the platform" }, "report_type": { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "account", "agent", "inbox", "label", "team" ] }, "required": true, "description": "Type of report" }, "report_metric": { "in": "query", "name": "metric", "schema": { "type": "string", "enum": [ "conversations_count", "incoming_messages_count", "outgoing_messages_count", "avg_first_response_time", "avg_resolution_time", "resolutions_count" ] }, "required": true, "description": "The type of metric" }, "public_inbox_identifier": { "in": "path", "name": "inbox_identifier", "schema": { "type": "string" }, "required": true, "description": "The identifier obtained from API inbox channel" }, "public_contact_identifier": { "in": "path", "name": "contact_identifier", "schema": { "type": "string" }, "required": true, "description": "The source id of contact obtained on contact create" }, "portal_id": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "The slug identifier of the portal" } }, "securitySchemes": { "userApiKey": { "type": "apiKey", "in": "header", "name": "api_access_token", "description": "This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user." }, "agentBotApiKey": { "type": "apiKey", "in": "header", "name": "api_access_token", "description": "This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis." }, "platformAppApiKey": { "type": "apiKey", "in": "header", "name": "api_access_token", "description": "This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles." } } }, "tags": [ { "name": "Accounts", "description": "Account management APIs" }, { "name": "Account Users", "description": "Account user management APIs" }, { "name": "AgentBots", "description": "Bot integrations" }, { "name": "Users", "description": "User management APIs" } ], "x-tagGroups": [ { "name": "Platform", "tags": [ "Accounts", "Account Users", "AgentBots", "Users" ] }, { "name": "Application", "tags": [ "Account AgentBots", "Account", "Agents", "Audit Logs", "Campaigns", "Canned Responses", "Contacts", "Contact Labels", "Conversation Assignments", "Conversation Labels", "Conversations", "Custom Attributes", "Custom Filters", "Inboxes", "Integrations", "Labels", "Messages", "Profile", "Reports", "Teams", "Webhooks", "Automation Rule", "Help Center" ] }, { "name": "Client", "tags": [ "Contacts API", "Conversations API", "Messages API" ] }, { "name": "Others", "tags": [ "CSAT Survey Page" ] } ] }