{ "openapi": "3.1.0", "info": { "title": "CloudChat API", "description": "Auto-generated OpenAPI spec from CloudChat Rails introspection. Generated by rake openapi:generate.", "version": "1.0.0", "contact": { "email": "dev@cloudhumans.com" } }, "servers": [ { "url": "http://localhost:3000", "description": "Primary" } ], "security": [ { "userApiKey": [] } ], "paths": { "/api/v1/accounts/{id}/update_active_at": { "post": { "operationId": "update_active_at_accounts", "summary": "Update Active At Accounts", "tags": [ "Accounts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{id}/cache_keys": { "get": { "operationId": "cache_keys_accounts", "summary": "Cache Keys Accounts", "tags": [ "Accounts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cache_keys": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/actions/contact_merge": { "post": { "operationId": "actions_create_contact_merges", "summary": "Create Contact Merges", "tags": [ "Contact Merges" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "additional_attributes": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "string" }, "last_activity_at": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/bulk_actions": { "post": { "operationId": "create_bulk_actions", "summary": "Create Bulk Actions", "tags": [ "Bulk Actions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "type": { "type": "string" }, "snoozed_until": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "assignee_id": { "type": "string" }, "team_id": { "type": "string" } } } }, "labels": { "type": "array", "items": { "type": "string" } }, "add": { "type": "array", "items": { "type": "string" } }, "remove": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/tenant": { "get": { "operationId": "show_tenant", "summary": "Get Tenant", "tags": [ "Tenant" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "tenantName": { "type": "string" }, "tenant_name": { "type": "string" }, "claudia_projects": { "type": "string" }, "name": { "type": "string" }, "eddie_workspaces": { "type": "string" }, "id": { "type": "string" }, "instance": { "type": "string" }, "tenantProjects": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/claudia/field_permissions": { "get": { "operationId": "claudia_show_field_permissions", "summary": "Get Field Permissions", "tags": [ "Field Permissions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/native_attribute_requirements": { "get": { "operationId": "index_native_attribute_requirements", "summary": "List Native Attribute Requirements", "tags": [ "Native Attribute Requirements" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "key": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_native_attribute_requirements", "summary": "Create Native Attribute Requirements", "tags": [ "Native Attribute Requirements" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "key": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/native_attribute_requirements/{id}": { "delete": { "operationId": "destroy_native_attribute_requirements", "summary": "Delete Native Attribute Requirements", "tags": [ "Native Attribute Requirements" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agents/bulk_create": { "post": { "operationId": "bulk_create_agents", "summary": "Bulk Create Agents", "tags": [ "Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agents/{id}/hub_user_data": { "get": { "operationId": "hub_user_data_agents", "summary": "Hub User Data Agents", "tags": [ "Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "claudia_projects": { "type": "string" }, "eddie_workspaces": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agents/{agent_id}/conversations": { "get": { "operationId": "agents_index_conversations", "summary": "List Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "sla_policy_id": { "type": "string" }, "campaign_id": { "type": "integer", "format": "int64" }, "assigned_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agents": { "get": { "operationId": "index_agents", "summary": "List Agents", "tags": [ "Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_agents", "summary": "Create Agents", "tags": [ "Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agents/{id}": { "patch": { "operationId": "update_agents", "summary": "Update Agents", "tags": [ "Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "generated_password": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_agents", "summary": "Update Agents", "tags": [ "Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "generated_password": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_agents", "summary": "Delete Agents", "tags": [ "Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agent_bots/{id}/avatar": { "delete": { "operationId": "avatar_agent_bots", "summary": "Avatar Agent Bots", "tags": [ "Agent Bots" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "bot_type": { "type": "integer" }, "bot_config": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agent_bots": { "get": { "operationId": "index_agent_bots", "summary": "List Agent Bots", "tags": [ "Agent Bots" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "bot_type": { "type": "integer" }, "bot_config": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_agent_bots", "summary": "Create Agent Bots", "tags": [ "Agent Bots" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string", "maxLength": 2048 }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "bot_type": { "type": "string", "enum": [ "webhook", "csml" ] }, "bot_config": { "type": "array", "items": { "type": "object", "properties": { "csml_content": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "bot_type": { "type": "integer" }, "bot_config": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/agent_bots/{id}": { "get": { "operationId": "show_agent_bots", "summary": "Get Agent Bots", "tags": [ "Agent Bots" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "bot_type": { "type": "integer" }, "bot_config": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_agent_bots", "summary": "Update Agent Bots", "tags": [ "Agent Bots" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string", "maxLength": 2048 }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "bot_type": { "type": "string", "enum": [ "webhook", "csml" ] }, "bot_config": { "type": "array", "items": { "type": "object", "properties": { "csml_content": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "bot_type": { "type": "integer" }, "bot_config": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_agent_bots", "summary": "Update Agent Bots", "tags": [ "Agent Bots" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string", "maxLength": 2048 }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "bot_type": { "type": "string", "enum": [ "webhook", "csml" ] }, "bot_config": { "type": "array", "items": { "type": "object", "properties": { "csml_content": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "bot_type": { "type": "integer" }, "bot_config": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_agent_bots", "summary": "Delete Agent Bots", "tags": [ "Agent Bots" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contact_inboxes/filter": { "post": { "operationId": "filter_contact_inboxes", "summary": "Filter Contact Inboxes", "tags": [ "Contact Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "inbox_id": { "type": "integer", "format": "int64" }, "source_id": { "type": "string" } }, "required": [ "inbox_id", "source_id" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "additional_attributes": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "string" }, "last_activity_at": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/assignable_agents": { "get": { "operationId": "index_assignable_agents", "summary": "List Assignable Agents", "tags": [ "Assignable Agents" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "meta": { "type": "object" }, "page": { "type": "string" }, "per_page": { "type": "string" }, "is_last_page": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/audit_logs": { "get": { "operationId": "show_audit_logs", "summary": "Get Audit Logs", "tags": [ "Audit Logs" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/callbacks/register_facebook_page": { "post": { "operationId": "register_facebook_page_callbacks", "summary": "Register Facebook Page Callbacks", "tags": [ "Callbacks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "channel_id": { "type": "string" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "avatar_url": { "type": "string" }, "page_id": { "type": "string" }, "enable_auto_assignment": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "get": { "operationId": "register_facebook_page_callbacks", "summary": "Register Facebook Page Callbacks", "tags": [ "Callbacks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "channel_id": { "type": "string" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "avatar_url": { "type": "string" }, "page_id": { "type": "string" }, "enable_auto_assignment": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/callbacks/facebook_pages": { "post": { "operationId": "facebook_pages_callbacks", "summary": "Facebook Pages Callbacks", "tags": [ "Callbacks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "page_details": { "type": "string" }, "user_access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/callbacks/reauthorize_page": { "post": { "operationId": "reauthorize_page_callbacks", "summary": "Reauthorize Page Callbacks", "tags": [ "Callbacks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/callbacks/register_instagram_account": { "post": { "operationId": "register_instagram_account_callbacks", "summary": "Register Instagram Account Callbacks", "tags": [ "Callbacks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "channel_id": { "type": "string" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "avatar_url": { "type": "string" }, "instagram_account_id": { "type": "string" }, "enable_auto_assignment": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/canned_responses": { "get": { "operationId": "index_canned_responses", "summary": "List Canned Responses", "tags": [ "Canned Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_canned_responses", "summary": "Create Canned Responses", "tags": [ "Canned Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/canned_responses/{id}": { "patch": { "operationId": "update_canned_responses", "summary": "Update Canned Responses", "tags": [ "Canned Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_canned_responses", "summary": "Update Canned Responses", "tags": [ "Canned Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_canned_responses", "summary": "Delete Canned Responses", "tags": [ "Canned Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/availability_reasons": { "get": { "operationId": "index_availability_reasons", "summary": "List Availability Reasons", "tags": [ "Availability Reasons" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_availability_reasons", "summary": "Create Availability Reasons", "tags": [ "Availability Reasons" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/availability_reasons/{id}": { "patch": { "operationId": "update_availability_reasons", "summary": "Update Availability Reasons", "tags": [ "Availability Reasons" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_availability_reasons", "summary": "Update Availability Reasons", "tags": [ "Availability Reasons" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_availability_reasons", "summary": "Delete Availability Reasons", "tags": [ "Availability Reasons" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/automation_rules/{automation_rule_id}/clone": { "post": { "operationId": "clone_automation_rules", "summary": "Clone Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "automation_rule_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "event_name": { "type": "string" }, "conditions": { "type": "object" }, "actions": { "type": "object" }, "created_on": { "type": "string" }, "updated_on": { "type": "string" }, "active": { "type": "boolean" }, "order_id": { "type": "integer" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/automation_rules/update_order": { "patch": { "operationId": "update_order_automation_rules", "summary": "Update Order Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "order_id": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "event_name": { "type": "string" }, "conditions": { "type": "object" }, "actions": { "type": "object" }, "created_on": { "type": "string" }, "updated_on": { "type": "string" }, "active": { "type": "boolean" }, "order_id": { "type": "integer" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/automation_rules": { "get": { "operationId": "index_automation_rules", "summary": "List Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "event_name": { "type": "string" }, "conditions": { "type": "object" }, "actions": { "type": "object" }, "created_on": { "type": "string" }, "updated_on": { "type": "string" }, "active": { "type": "boolean" }, "order_id": { "type": "integer" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_automation_rules", "summary": "Create Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "event_name": { "type": "string" }, "conditions": { "type": "object" }, "actions": { "type": "object" }, "created_on": { "type": "string" }, "updated_on": { "type": "string" }, "active": { "type": "boolean" }, "order_id": { "type": "integer" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/automation_rules/{id}": { "get": { "operationId": "show_automation_rules", "summary": "Get Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "event_name": { "type": "string" }, "conditions": { "type": "object" }, "actions": { "type": "object" }, "created_on": { "type": "string" }, "updated_on": { "type": "string" }, "active": { "type": "boolean" }, "order_id": { "type": "integer" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_automation_rules", "summary": "Update Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "event_name": { "type": "string" }, "conditions": { "type": "object" }, "actions": { "type": "object" }, "created_on": { "type": "string" }, "updated_on": { "type": "string" }, "active": { "type": "boolean" }, "order_id": { "type": "integer" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_automation_rules", "summary": "Update Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "event_name": { "type": "string" }, "conditions": { "type": "object" }, "actions": { "type": "object" }, "created_on": { "type": "string" }, "updated_on": { "type": "string" }, "active": { "type": "boolean" }, "order_id": { "type": "integer" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_automation_rules", "summary": "Delete Automation Rules", "tags": [ "Automation Rules" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/macros/{id}/execute": { "post": { "operationId": "execute_macros", "summary": "Execute Macros", "tags": [ "Macros" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "visibility": { "type": "string", "enum": [ "personal", "global" ] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_name": { "type": "string" } } } }, "action_params": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "409": { "description": "Macro already running on this conversation, or executed moments ago" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/macros": { "get": { "operationId": "index_macros", "summary": "List Macros", "tags": [ "Macros" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "name": { "type": "string" }, "visibility": { "type": "integer" }, "created_by": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "updated_by": { "type": "object" }, "actions": { "type": "object" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_macros", "summary": "Create Macros", "tags": [ "Macros" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "visibility": { "type": "string", "enum": [ "personal", "global" ] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_name": { "type": "string" } } } }, "action_params": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "visibility": { "type": "integer" }, "created_by": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "updated_by": { "type": "object" }, "actions": { "type": "object" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/macros/{id}": { "get": { "operationId": "show_macros", "summary": "Get Macros", "tags": [ "Macros" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "visibility": { "type": "integer" }, "created_by": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "updated_by": { "type": "object" }, "actions": { "type": "object" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_macros", "summary": "Update Macros", "tags": [ "Macros" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "visibility": { "type": "string", "enum": [ "personal", "global" ] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_name": { "type": "string" } } } }, "action_params": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "visibility": { "type": "integer" }, "created_by": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "updated_by": { "type": "object" }, "actions": { "type": "object" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_macros", "summary": "Update Macros", "tags": [ "Macros" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "visibility": { "type": "string", "enum": [ "personal", "global" ] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_name": { "type": "string" } } } }, "action_params": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "visibility": { "type": "integer" }, "created_by": { "type": "object" }, "account_id": { "type": "integer", "format": "int64" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "updated_by": { "type": "object" }, "actions": { "type": "object" }, "files": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_macros", "summary": "Delete Macros", "tags": [ "Macros" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/sla_policies": { "get": { "operationId": "index_sla_policies", "summary": "List Sla Policies", "tags": [ "Sla Policies" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_sla_policies", "summary": "Create Sla Policies", "tags": [ "Sla Policies" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/sla_policies/{id}": { "get": { "operationId": "show_sla_policies", "summary": "Get Sla Policies", "tags": [ "Sla Policies" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_sla_policies", "summary": "Update Sla Policies", "tags": [ "Sla Policies" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_sla_policies", "summary": "Update Sla Policies", "tags": [ "Sla Policies" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "first_response_time_target": { "type": "integer" }, "next_response_time_target": { "type": "integer" }, "time_to_resolve_target": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_sla_policies", "summary": "Delete Sla Policies", "tags": [ "Sla Policies" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/custom_roles": { "get": { "operationId": "index_custom_roles", "summary": "List Custom Roles", "tags": [ "Custom Roles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_custom_roles", "summary": "Create Custom Roles", "tags": [ "Custom Roles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/custom_roles/{id}": { "get": { "operationId": "show_custom_roles", "summary": "Get Custom Roles", "tags": [ "Custom Roles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_custom_roles", "summary": "Update Custom Roles", "tags": [ "Custom Roles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_custom_roles", "summary": "Update Custom Roles", "tags": [ "Custom Roles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_custom_roles", "summary": "Delete Custom Roles", "tags": [ "Custom Roles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/campaigns/preview_filter": { "post": { "operationId": "preview_filter_campaigns", "summary": "Preview Filter Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "trigger_only_during_business_hours": { "type": "boolean" }, "inbox_id": { "type": "integer", "format": "int64" }, "sender_id": { "type": "integer" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "conversation_label_id": { "type": "integer", "format": "int64" }, "team_id": { "type": "integer", "format": "int64" }, "trigger_rules": { "type": "object", "additionalProperties": true } }, "required": [ "title", "message", "inbox_id" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/campaigns/preview_csv": { "post": { "operationId": "preview_csv_campaigns", "summary": "Preview Csv Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "trigger_only_during_business_hours": { "type": "boolean" }, "inbox_id": { "type": "integer", "format": "int64" }, "sender_id": { "type": "integer" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "conversation_label_id": { "type": "integer", "format": "int64" }, "team_id": { "type": "integer", "format": "int64" }, "trigger_rules": { "type": "object", "additionalProperties": true } }, "required": [ "title", "message", "inbox_id" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/campaigns/preview_labels": { "post": { "operationId": "preview_labels_campaigns", "summary": "Preview Labels Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "trigger_only_during_business_hours": { "type": "boolean" }, "inbox_id": { "type": "integer", "format": "int64" }, "sender_id": { "type": "integer" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "conversation_label_id": { "type": "integer", "format": "int64" }, "team_id": { "type": "integer", "format": "int64" }, "trigger_rules": { "type": "object", "additionalProperties": true } }, "required": [ "title", "message", "inbox_id" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/campaigns/{id}/progress": { "get": { "operationId": "progress_campaigns", "summary": "Progress Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "campaign_id": { "type": "string" }, "delivered_count": { "type": "string" }, "recipients_count": { "type": "integer" }, "progress_pct": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/campaigns": { "get": { "operationId": "index_campaigns", "summary": "List Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "campaign_status": { "type": "integer" }, "campaign_type": { "type": "integer" }, "recipients_count": { "type": "integer" }, "tag_titles": { "type": "string" }, "inbox": { "type": "object" }, "name": { "type": "string" }, "sender": { "type": "object" }, "trigger_rules": { "type": "object" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_campaigns", "summary": "Create Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "trigger_only_during_business_hours": { "type": "boolean" }, "inbox_id": { "type": "integer", "format": "int64" }, "sender_id": { "type": "integer" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "conversation_label_id": { "type": "integer", "format": "int64" }, "team_id": { "type": "integer", "format": "int64" }, "trigger_rules": { "type": "object", "additionalProperties": true } }, "required": [ "title", "message", "inbox_id" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "campaign_status": { "type": "integer" }, "campaign_type": { "type": "integer" }, "recipients_count": { "type": "integer" }, "tag_titles": { "type": "string" }, "inbox": { "type": "object" }, "name": { "type": "string" }, "sender": { "type": "object" }, "trigger_rules": { "type": "object" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/campaigns/{id}": { "get": { "operationId": "show_campaigns", "summary": "Get Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "campaign_status": { "type": "integer" }, "campaign_type": { "type": "integer" }, "recipients_count": { "type": "integer" }, "tag_titles": { "type": "string" }, "inbox": { "type": "object" }, "name": { "type": "string" }, "sender": { "type": "object" }, "trigger_rules": { "type": "object" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_campaigns", "summary": "Update Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "trigger_only_during_business_hours": { "type": "boolean" }, "inbox_id": { "type": "integer", "format": "int64" }, "sender_id": { "type": "integer" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "conversation_label_id": { "type": "integer", "format": "int64" }, "team_id": { "type": "integer", "format": "int64" }, "trigger_rules": { "type": "object", "additionalProperties": true } }, "required": [ "title", "message", "inbox_id" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "campaign_status": { "type": "integer" }, "campaign_type": { "type": "integer" }, "recipients_count": { "type": "integer" }, "tag_titles": { "type": "string" }, "inbox": { "type": "object" }, "name": { "type": "string" }, "sender": { "type": "object" }, "trigger_rules": { "type": "object" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_campaigns", "summary": "Update Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "trigger_only_during_business_hours": { "type": "boolean" }, "inbox_id": { "type": "integer", "format": "int64" }, "sender_id": { "type": "integer" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "conversation_label_id": { "type": "integer", "format": "int64" }, "team_id": { "type": "integer", "format": "int64" }, "trigger_rules": { "type": "object", "additionalProperties": true } }, "required": [ "title", "message", "inbox_id" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "boolean" }, "campaign_status": { "type": "integer" }, "campaign_type": { "type": "integer" }, "recipients_count": { "type": "integer" }, "tag_titles": { "type": "string" }, "inbox": { "type": "object" }, "name": { "type": "string" }, "sender": { "type": "object" }, "trigger_rules": { "type": "object" }, "scheduled_at": { "type": "string", "format": "date-time" }, "minutes_to_auto_resolve": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_campaigns", "summary": "Delete Campaigns", "tags": [ "Campaigns" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/dashboard_apps": { "get": { "operationId": "index_dashboard_apps", "summary": "List Dashboard Apps", "tags": [ "Dashboard Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_dashboard_apps", "summary": "Create Dashboard Apps", "tags": [ "Dashboard Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/dashboard_apps/{id}": { "get": { "operationId": "show_dashboard_apps", "summary": "Get Dashboard Apps", "tags": [ "Dashboard Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_dashboard_apps", "summary": "Update Dashboard Apps", "tags": [ "Dashboard Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_dashboard_apps", "summary": "Update Dashboard Apps", "tags": [ "Dashboard Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_dashboard_apps", "summary": "Delete Dashboard Apps", "tags": [ "Dashboard Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/channels/twilio_channel": { "post": { "operationId": "channels_create_twilio_channels", "summary": "Create Twilio Channels", "tags": [ "Twilio Channels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "account_id": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "account_sid": { "type": "string" }, "auth_token": { "type": "string" }, "name": { "type": "string" }, "medium": { "type": "string" }, "api_key_sid": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/meta": { "get": { "operationId": "meta_conversations", "summary": "Meta Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "mine_count": { "type": "string" }, "assigned_count": { "type": "string" }, "unassigned_count": { "type": "string" }, "all_count": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/search": { "get": { "operationId": "search_conversations", "summary": "Search Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Search query" }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "mine_count": { "type": "string" }, "unassigned_count": { "type": "string" }, "all_count": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "contact": { "type": "object" }, "name": { "type": "string" }, "inbox": { "type": "object" }, "channel_type": { "type": "string" }, "messages": { "type": "object" }, "content": { "type": "string" }, "sender_name": { "type": "string" }, "message_type": { "type": "string" }, "account_id": { "type": "integer" }, "proactively_initiated": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/filter": { "post": { "operationId": "filter_conversations", "summary": "Filter Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "mine_count": { "type": "string" }, "unassigned_count": { "type": "string" }, "all_count": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/create_proactive_whatsapp_conversation": { "post": { "operationId": "create_proactive_whatsapp_conversation_conversations", "summary": "Create Proactive Whatsapp Conversation Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{id}/translate": { "post": { "operationId": "conversations_translate_messages", "summary": "Translate Messages", "tags": [ "Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "target_language": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{id}/retry": { "post": { "operationId": "conversations_retry_messages", "summary": "Retry Messages", "tags": [ "Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "target_language": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "inbox_id": { "type": "integer" }, "echo_id": { "type": "string" }, "conversation_id": { "type": "integer" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "status": { "type": "integer" }, "content_attributes": { "type": "object" }, "additional_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "private": { "type": "boolean" }, "source_id": { "type": "string" }, "has_successful_webhooks": { "type": "string" }, "has_failed_webhooks": { "type": "string" }, "webhook_deliveries": { "type": "string" }, "sender": { "type": "string" }, "attachments": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages": { "get": { "operationId": "conversations_index_messages", "summary": "List Messages", "tags": [ "Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "labels": { "type": "string" }, "additional_attributes": { "type": "object" }, "contact": { "type": "string" }, "assignee": { "type": "string" }, "agent_last_seen_at": { "type": "string" }, "assignee_last_seen_at": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "inbox_id": { "type": "integer" }, "echo_id": { "type": "string" }, "conversation_id": { "type": "integer" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "status": { "type": "integer" }, "content_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "private": { "type": "boolean" }, "source_id": { "type": "string" }, "has_successful_webhooks": { "type": "string" }, "has_failed_webhooks": { "type": "string" }, "webhook_deliveries": { "type": "string" }, "sender": { "type": "string" }, "attachments": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "conversations_create_messages", "summary": "Create Messages", "tags": [ "Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "target_language": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "inbox_id": { "type": "integer" }, "echo_id": { "type": "string" }, "conversation_id": { "type": "integer" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "status": { "type": "integer" }, "content_attributes": { "type": "object" }, "additional_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "private": { "type": "boolean" }, "source_id": { "type": "string" }, "has_successful_webhooks": { "type": "string" }, "has_failed_webhooks": { "type": "string" }, "webhook_deliveries": { "type": "string" }, "sender": { "type": "string" }, "attachments": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{id}": { "delete": { "operationId": "conversations_destroy_messages", "summary": "Delete Messages", "tags": [ "Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "inbox_id": { "type": "integer" }, "echo_id": { "type": "string" }, "conversation_id": { "type": "integer" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "status": { "type": "integer" }, "content_attributes": { "type": "object" }, "additional_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "private": { "type": "boolean" }, "source_id": { "type": "string" }, "has_successful_webhooks": { "type": "string" }, "has_failed_webhooks": { "type": "string" }, "webhook_deliveries": { "type": "string" }, "sender": { "type": "string" }, "attachments": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments": { "post": { "operationId": "conversations_create_assignments", "summary": "Create Assignments", "tags": [ "Assignments" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "assignee": { "type": "string" }, "conversation_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels": { "get": { "operationId": "conversations_index_labels", "summary": "List Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "conversations_create_labels", "summary": "Create Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "conversation_id": { "type": "string" }, "append": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/participants": { "get": { "operationId": "conversations_show_participants", "summary": "Get Participants", "tags": [ "Participants" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "conversations_update_participants", "summary": "Update Participants", "tags": [ "Participants" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "conversations_update_participants", "summary": "Update Participants", "tags": [ "Participants" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "conversations_destroy_participants", "summary": "Delete Participants", "tags": [ "Participants" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "conversations_create_participants", "summary": "Create Participants", "tags": [ "Participants" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/contact": { "get": { "operationId": "conversations_show_contacts", "summary": "Get Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/direct_uploads": { "post": { "operationId": "conversations_create_direct_uploads", "summary": "Create Direct Uploads", "tags": [ "Direct Uploads" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/draft_messages": { "get": { "operationId": "conversations_show_draft_messages", "summary": "Get Draft Messages", "tags": [ "Draft Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_draft": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "conversations_update_draft_messages", "summary": "Update Draft Messages", "tags": [ "Draft Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "conversations_update_draft_messages", "summary": "Update Draft Messages", "tags": [ "Draft Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "conversations_destroy_draft_messages", "summary": "Delete Draft Messages", "tags": [ "Draft Messages" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes": { "patch": { "operationId": "conversations_update_custom_attributes", "summary": "Update Custom Attributes", "tags": [ "Custom Attributes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "conversations_update_custom_attributes", "summary": "Update Custom Attributes", "tags": [ "Custom Attributes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{conversation_id}/subscribers": { "delete": { "operationId": "conversations_destroy_subscribers", "summary": "Delete Subscribers", "tags": [ "Subscribers" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "conversations_create_subscribers", "summary": "Create Subscribers", "tags": [ "Subscribers" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/mute": { "post": { "operationId": "mute_conversations", "summary": "Mute Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/unmute": { "post": { "operationId": "unmute_conversations", "summary": "Unmute Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/transcript": { "post": { "operationId": "transcript_conversations", "summary": "Transcript Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/toggle_status": { "post": { "operationId": "toggle_status_conversations", "summary": "Toggle Status Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "payload": { "type": "object" }, "success": { "type": "string" }, "conversation_id": { "type": "string" }, "current_status": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/toggle_priority": { "post": { "operationId": "toggle_priority_conversations", "summary": "Toggle Priority Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/toggle_typing_status": { "post": { "operationId": "toggle_typing_status_conversations", "summary": "Toggle Typing Status Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/update_last_seen": { "post": { "operationId": "update_last_seen_conversations", "summary": "Update Last Seen Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/unread": { "post": { "operationId": "unread_conversations", "summary": "Unread Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/custom_attributes": { "post": { "operationId": "custom_attributes_conversations", "summary": "Custom Attributes Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "custom_attributes": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/attachments": { "get": { "operationId": "attachments_conversations", "summary": "Attachments Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "string" }, "message_id": { "type": "string" }, "thumb_url": { "type": "string" }, "data_url": { "type": "string" }, "file_size": { "type": "string" }, "file_type": { "type": "string" }, "extension": { "type": "string" }, "width": { "type": "string" }, "height": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "sender": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}/force_email_channel": { "patch": { "operationId": "force_email_channel_conversations", "summary": "Force Email Channel Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations": { "get": { "operationId": "index_conversations", "summary": "List Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "mine_count": { "type": "string" }, "assigned_count": { "type": "string" }, "unassigned_count": { "type": "string" }, "all_count": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_conversations", "summary": "Create Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/conversations/{id}": { "get": { "operationId": "show_conversations", "summary": "Get Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_conversations", "summary": "Update Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_conversations", "summary": "Update Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/search/conversations": { "get": { "operationId": "conversations_search", "summary": "Conversations Search", "tags": [ "Search" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "conversations": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "string" }, "created_at": { "type": "string" }, "message": { "type": "object" }, "contact": { "type": "object" }, "inbox": { "type": "object" }, "agent": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/search/messages": { "get": { "operationId": "messages_search", "summary": "Messages Search", "tags": [ "Search" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "messages": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/search/contacts": { "get": { "operationId": "contacts_search", "summary": "Contacts Search", "tags": [ "Search" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "contacts": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/search": { "get": { "operationId": "index_search", "summary": "List Search", "tags": [ "Search" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "conversations": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "string" }, "created_at": { "type": "string" }, "message": { "type": "object" }, "contact": { "type": "object" }, "inbox": { "type": "object" }, "agent": { "type": "object" }, "contacts": { "type": "array", "items": { "type": "object" } }, "messages": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/active": { "get": { "operationId": "active_contacts", "summary": "Active Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "count": { "type": "string" }, "current_page": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/search": { "get": { "operationId": "search_contacts", "summary": "Search Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Search query" }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "current_page": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/search/count": { "get": { "operationId": "search_count_contacts", "summary": "Search Count Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/email": { "get": { "operationId": "show_by_email_contacts", "summary": "Show By Email Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/filter": { "post": { "operationId": "filter_contacts", "summary": "Filter Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "count": { "type": "string" }, "current_page": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/import": { "post": { "operationId": "import_contacts", "summary": "Import Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/export": { "post": { "operationId": "export_contacts", "summary": "Export Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/bulk_create": { "post": { "operationId": "bulk_create_contacts", "summary": "Bulk Create Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" }, "blocked": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } } } }, "tags_add": { "type": "array", "items": { "type": "string" } }, "tags_remove": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" }, "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/external_import": { "post": { "operationId": "external_import_contacts", "summary": "External Import Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/delete_tags": { "delete": { "operationId": "delete_tags_contacts", "summary": "Delete Tags Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes": { "get": { "operationId": "contactable_inboxes_contacts", "summary": "Contactable Inboxes Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "inbox": { "type": "object" }, "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "object" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "source_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{id}/destroy_custom_attributes": { "post": { "operationId": "destroy_custom_attributes_contacts", "summary": "Destroy Custom Attributes Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{id}/avatar": { "delete": { "operationId": "avatar_contacts", "summary": "Avatar Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/conversations": { "get": { "operationId": "contacts_index_conversations", "summary": "List Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "sender": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "channel": { "type": "string" }, "assignee": { "type": "object" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "team": { "type": "object" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "string" }, "is_member": { "type": "string" }, "hmac_verified": { "type": "string" }, "internal_id": { "type": "string" }, "messages": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "assignee_last_seen_at": { "type": "string", "format": "date-time" }, "can_reply": { "type": "string" }, "cannot_reply_reason": { "type": "string" }, "instagram_follow_up_window_open": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "inbox_id": { "type": "integer" }, "labels": { "type": "string" }, "muted": { "type": "string" }, "snoozed_until": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "timestamp": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "last_non_activity_message": { "type": "string" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "campaign_id": { "type": "integer", "format": "int64" }, "proactively_initiated": { "type": "boolean" }, "sla": { "type": "object" }, "sla_policy_id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "sla_policy_description": { "type": "string" }, "sla_policy_name": { "type": "string" }, "first_response_time": { "type": "string" }, "next_response_time": { "type": "string" }, "time_to_resolve": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/contact_inboxes": { "post": { "operationId": "contacts_create_contact_inboxes", "summary": "Create Contact Inboxes", "tags": [ "Contact Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/contact_inboxes/{id}": { "delete": { "operationId": "contacts_destroy_contact_inboxes", "summary": "Delete Contact Inboxes", "tags": [ "Contact Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/labels": { "get": { "operationId": "contacts_index_labels", "summary": "List Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "contacts_create_labels", "summary": "Create Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "labels": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/notes": { "get": { "operationId": "contacts_index_notes", "summary": "List Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "contact_id": { "type": "integer", "format": "int64" }, "user": { "type": "object" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "contacts_create_notes", "summary": "Create Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "contact_id": { "type": "integer", "format": "int64" }, "user": { "type": "object" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/notes/new": { "get": { "operationId": "contacts_new_notes", "summary": "New Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/notes/{id}/edit": { "get": { "operationId": "contacts_edit_notes", "summary": "Edit Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{contact_id}/notes/{id}": { "get": { "operationId": "contacts_show_notes", "summary": "Get Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "contact_id": { "type": "integer", "format": "int64" }, "user": { "type": "object" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "contacts_update_notes", "summary": "Update Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "contact_id": { "type": "integer", "format": "int64" }, "user": { "type": "object" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "contacts_update_notes", "summary": "Update Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "contact_id": { "type": "integer", "format": "int64" }, "user": { "type": "object" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "contacts_destroy_notes", "summary": "Delete Notes", "tags": [ "Notes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts": { "get": { "operationId": "index_contacts", "summary": "List Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object" }, "count": { "type": "string" }, "current_page": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_contacts", "summary": "Create Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "contact": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "contact_inbox": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/contacts/{id}": { "get": { "operationId": "show_contacts", "summary": "Get Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_contacts", "summary": "Update Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_contacts", "summary": "Update Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "avatar": { "type": "string" }, "avatar_url": { "type": "string" }, "additional_attributes": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "additional_attributes": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "object" }, "last_activity_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "boolean" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_contacts", "summary": "Delete Contacts", "tags": [ "Contacts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/csat_survey_responses/metrics": { "get": { "operationId": "metrics_csat_survey_responses", "summary": "Metrics Csat Survey Responses", "tags": [ "Csat Survey Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "type": "string" }, "ratings_count": { "type": "string" }, "total_sent_messages_count": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/csat_survey_responses/download": { "get": { "operationId": "download_csat_survey_responses", "summary": "Download Csat Survey Responses", "tags": [ "Csat Survey Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/csat_survey_responses": { "get": { "operationId": "index_csat_survey_responses", "summary": "List Csat Survey Responses", "tags": [ "Csat Survey Responses" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rating": { "type": "integer" }, "feedback_message": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "message_id": { "type": "integer", "format": "int64" }, "contact": { "type": "object" }, "additional_attributes": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "identifier": { "type": "string" }, "thumbnail": { "type": "string" }, "custom_attributes": { "type": "string" }, "last_activity_at": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "blocked": { "type": "string" }, "contact_inboxes": { "type": "object" }, "source_id": { "type": "string" }, "inbox": { "type": "object" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "string" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "enable_email_collect": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "string" }, "auto_assignment_config": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "string" }, "create_conversation_via_api": { "type": "string" }, "lock_to_single_conversation": { "type": "string" }, "sender_name_type": { "type": "string" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" }, "conversation_id": { "type": "integer", "format": "int64" }, "assigned_agent": { "type": "object" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "available_name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/applied_slas/metrics": { "get": { "operationId": "metrics_applied_slas", "summary": "Metrics Applied Slas", "tags": [ "Applied Slas" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/applied_slas/download": { "get": { "operationId": "download_applied_slas", "summary": "Download Applied Slas", "tags": [ "Applied Slas" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/applied_slas": { "get": { "operationId": "index_applied_slas", "summary": "List Applied Slas", "tags": [ "Applied Slas" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/custom_attribute_definitions/update_order": { "post": { "operationId": "update_order_custom_attribute_definitions", "summary": "Update Order Custom Attribute Definitions", "tags": [ "Custom Attribute Definitions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "order_id": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "attribute_display_name": { "type": "string" }, "attribute_display_type": { "type": "integer" }, "attribute_description": { "type": "string" }, "attribute_key": { "type": "string" }, "regex_pattern": { "type": "string" }, "regex_cue": { "type": "string" }, "attribute_values": { "type": "object" }, "attribute_model": { "type": "integer" }, "default_value": { "type": "integer" }, "required": { "type": "boolean" }, "condition_to_view": { "type": "object" }, "order_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/custom_attribute_definitions": { "get": { "operationId": "index_custom_attribute_definitions", "summary": "List Custom Attribute Definitions", "tags": [ "Custom Attribute Definitions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "attribute_display_name": { "type": "string" }, "attribute_display_type": { "type": "integer" }, "attribute_description": { "type": "string" }, "attribute_key": { "type": "string" }, "regex_pattern": { "type": "string" }, "regex_cue": { "type": "string" }, "attribute_values": { "type": "object" }, "attribute_model": { "type": "integer" }, "default_value": { "type": "integer" }, "required": { "type": "boolean" }, "condition_to_view": { "type": "object" }, "order_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_custom_attribute_definitions", "summary": "Create Custom Attribute Definitions", "tags": [ "Custom Attribute Definitions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "filter_type": { "type": "string" }, "attribute_model": { "type": "string", "enum": [ "conversation_attribute", "contact_attribute" ] } }, "required": [ "attribute_model" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "attribute_display_name": { "type": "string" }, "attribute_display_type": { "type": "integer" }, "attribute_description": { "type": "string" }, "attribute_key": { "type": "string" }, "regex_pattern": { "type": "string" }, "regex_cue": { "type": "string" }, "attribute_values": { "type": "object" }, "attribute_model": { "type": "integer" }, "default_value": { "type": "integer" }, "required": { "type": "boolean" }, "condition_to_view": { "type": "object" }, "order_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}": { "get": { "operationId": "show_custom_attribute_definitions", "summary": "Get Custom Attribute Definitions", "tags": [ "Custom Attribute Definitions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "attribute_display_name": { "type": "string" }, "attribute_display_type": { "type": "integer" }, "attribute_description": { "type": "string" }, "attribute_key": { "type": "string" }, "regex_pattern": { "type": "string" }, "regex_cue": { "type": "string" }, "attribute_values": { "type": "object" }, "attribute_model": { "type": "integer" }, "default_value": { "type": "integer" }, "required": { "type": "boolean" }, "condition_to_view": { "type": "object" }, "order_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_custom_attribute_definitions", "summary": "Update Custom Attribute Definitions", "tags": [ "Custom Attribute Definitions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "filter_type": { "type": "string" }, "attribute_model": { "type": "string", "enum": [ "conversation_attribute", "contact_attribute" ] } }, "required": [ "attribute_model" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "attribute_display_name": { "type": "string" }, "attribute_display_type": { "type": "integer" }, "attribute_description": { "type": "string" }, "attribute_key": { "type": "string" }, "regex_pattern": { "type": "string" }, "regex_cue": { "type": "string" }, "attribute_values": { "type": "object" }, "attribute_model": { "type": "integer" }, "default_value": { "type": "integer" }, "required": { "type": "boolean" }, "condition_to_view": { "type": "object" }, "order_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_custom_attribute_definitions", "summary": "Update Custom Attribute Definitions", "tags": [ "Custom Attribute Definitions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "filter_type": { "type": "string" }, "attribute_model": { "type": "string", "enum": [ "conversation_attribute", "contact_attribute" ] } }, "required": [ "attribute_model" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "attribute_display_name": { "type": "string" }, "attribute_display_type": { "type": "integer" }, "attribute_description": { "type": "string" }, "attribute_key": { "type": "string" }, "regex_pattern": { "type": "string" }, "regex_cue": { "type": "string" }, "attribute_values": { "type": "object" }, "attribute_model": { "type": "integer" }, "default_value": { "type": "integer" }, "required": { "type": "boolean" }, "condition_to_view": { "type": "object" }, "order_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_custom_attribute_definitions", "summary": "Delete Custom Attribute Definitions", "tags": [ "Custom Attribute Definitions" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/custom_filters": { "get": { "operationId": "index_custom_filters", "summary": "List Custom Filters", "tags": [ "Custom Filters" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "filter_type": { "type": "integer" }, "visibility": { "type": "integer" }, "query": { "type": "object" }, "count": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_custom_filters", "summary": "Create Custom Filters", "tags": [ "Custom Filters" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "filter_type": { "type": "string", "enum": [ "conversation", "contact", "report" ] } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "filter_type": { "type": "integer" }, "visibility": { "type": "integer" }, "query": { "type": "object" }, "count": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/custom_filters/{id}": { "get": { "operationId": "show_custom_filters", "summary": "Get Custom Filters", "tags": [ "Custom Filters" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "filter_type": { "type": "integer" }, "visibility": { "type": "integer" }, "query": { "type": "object" }, "count": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_custom_filters", "summary": "Update Custom Filters", "tags": [ "Custom Filters" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "filter_type": { "type": "string", "enum": [ "conversation", "contact", "report" ] } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "filter_type": { "type": "integer" }, "visibility": { "type": "integer" }, "query": { "type": "object" }, "count": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_custom_filters", "summary": "Update Custom Filters", "tags": [ "Custom Filters" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "filter_type": { "type": "string", "enum": [ "conversation", "contact", "report" ] } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "filter_type": { "type": "integer" }, "visibility": { "type": "integer" }, "query": { "type": "object" }, "count": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_custom_filters", "summary": "Delete Custom Filters", "tags": [ "Custom Filters" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/assignable_agents": { "get": { "operationId": "assignable_agents_inboxes", "summary": "Assignable Agents Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "integer" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" }, "meta": { "type": "object" }, "page": { "type": "string" }, "per_page": { "type": "string" }, "is_last_page": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/campaigns": { "get": { "operationId": "campaigns_inboxes", "summary": "Campaigns Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "enabled": { "type": "string" }, "campaign_status": { "type": "string" }, "campaign_type": { "type": "string" }, "recipients_count": { "type": "string" }, "tag_titles": { "type": "string" }, "inbox": { "type": "object" }, "name": { "type": "string" }, "sender": { "type": "object" }, "trigger_rules": { "type": "string" }, "scheduled_at": { "type": "string" }, "minutes_to_auto_resolve": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/response_sources": { "get": { "operationId": "response_sources_inboxes", "summary": "Response Sources Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "source_link": { "type": "string" }, "source_type": { "type": "string" }, "account_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "response_documents": { "type": "object" }, "document_link": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/agent_bot": { "get": { "operationId": "agent_bot_inboxes", "summary": "Agent Bot Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "agent_bot": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "bot_type": { "type": "string" }, "bot_config": { "type": "string" }, "account_id": { "type": "integer" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot": { "post": { "operationId": "set_agent_bot_inboxes", "summary": "Set Agent Bot Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/sync_whatsapp_templates": { "post": { "operationId": "sync_whatsapp_templates_inboxes", "summary": "Sync Whatsapp Templates Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/create_whatsapp_template": { "post": { "operationId": "create_whatsapp_template_inboxes", "summary": "Create Whatsapp Template Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/retry_whatsapp_connection": { "post": { "operationId": "retry_whatsapp_connection_inboxes", "summary": "Retry Whatsapp Connection Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/reconnect_whatsapp": { "post": { "operationId": "reconnect_whatsapp_inboxes", "summary": "Reconnect Whatsapp Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/resubscribe_instagram": { "post": { "operationId": "resubscribe_instagram_inboxes", "summary": "Resubscribe Instagram Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/update_whatsapp_template": { "put": { "operationId": "update_whatsapp_template_inboxes", "summary": "Update Whatsapp Template Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/delete_whatsapp_template": { "delete": { "operationId": "delete_whatsapp_template_inboxes", "summary": "Delete Whatsapp Template Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}/avatar": { "delete": { "operationId": "avatar_inboxes", "summary": "Avatar Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/conversations/import": { "post": { "operationId": "inboxes_import_conversations", "summary": "Import Conversations", "tags": [ "Conversations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes": { "get": { "operationId": "index_inboxes", "summary": "List Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "integer" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "boolean" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "boolean" }, "enable_email_collect": { "type": "boolean" }, "csat_survey_enabled": { "type": "boolean" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "boolean" }, "auto_assignment_config": { "type": "object" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "boolean" }, "create_conversation_via_api": { "type": "boolean" }, "lock_to_single_conversation": { "type": "boolean" }, "sender_name_type": { "type": "integer" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_inboxes", "summary": "Create Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "integer" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "boolean" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "boolean" }, "enable_email_collect": { "type": "boolean" }, "csat_survey_enabled": { "type": "boolean" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "boolean" }, "auto_assignment_config": { "type": "object" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "boolean" }, "create_conversation_via_api": { "type": "boolean" }, "lock_to_single_conversation": { "type": "boolean" }, "sender_name_type": { "type": "integer" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inboxes/{id}": { "get": { "operationId": "show_inboxes", "summary": "Get Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "integer" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "boolean" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "boolean" }, "enable_email_collect": { "type": "boolean" }, "csat_survey_enabled": { "type": "boolean" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "boolean" }, "auto_assignment_config": { "type": "object" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "boolean" }, "create_conversation_via_api": { "type": "boolean" }, "lock_to_single_conversation": { "type": "boolean" }, "sender_name_type": { "type": "integer" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_inboxes", "summary": "Update Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "integer" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "boolean" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "boolean" }, "enable_email_collect": { "type": "boolean" }, "csat_survey_enabled": { "type": "boolean" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "boolean" }, "auto_assignment_config": { "type": "object" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "boolean" }, "create_conversation_via_api": { "type": "boolean" }, "lock_to_single_conversation": { "type": "boolean" }, "sender_name_type": { "type": "integer" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_inboxes", "summary": "Update Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "channel": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } } } } }, "required": [ "channel" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "integer" }, "name": { "type": "string" }, "channel_type": { "type": "string" }, "greeting_enabled": { "type": "boolean" }, "greeting_message": { "type": "string" }, "working_hours_enabled": { "type": "boolean" }, "enable_email_collect": { "type": "boolean" }, "csat_survey_enabled": { "type": "boolean" }, "follow_up_enabled": { "type": "string" }, "follow_up_after": { "type": "string" }, "follow_up_message_content": { "type": "string" }, "enable_auto_assignment": { "type": "boolean" }, "auto_assignment_config": { "type": "object" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "callback_webhook_url": { "type": "string" }, "allow_messages_after_resolved": { "type": "boolean" }, "create_conversation_via_api": { "type": "boolean" }, "lock_to_single_conversation": { "type": "boolean" }, "sender_name_type": { "type": "integer" }, "business_name": { "type": "string" }, "enable_multi_conversation": { "type": "string" }, "help_center": { "type": "object" }, "slug": { "type": "string" }, "tweets_enabled": { "type": "string" }, "widget_color": { "type": "string" }, "website_url": { "type": "string" }, "hmac_mandatory": { "type": "string" }, "allowed_domains": { "type": "string" }, "welcome_title": { "type": "string" }, "welcome_tagline": { "type": "string" }, "web_widget_script": { "type": "string" }, "web_widget_advanced_script": { "type": "string" }, "web_widget_script_with_user_identifier_hmac": { "type": "string" }, "website_token": { "type": "string" }, "selected_feature_flags": { "type": "string" }, "reply_time": { "type": "string" }, "hmac_token": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "continuity_via_email": { "type": "string" }, "continuity_channel_id": { "type": "string" }, "widget_locale": { "type": "string" }, "page_id": { "type": "string" }, "reauthorization_required": { "type": "string" }, "messaging_service_sid": { "type": "string" }, "phone_number": { "type": "string" }, "medium": { "type": "string" }, "forward_to_email": { "type": "string" }, "email": { "type": "string" }, "imap_login": { "type": "string" }, "imap_password": { "type": "string" }, "imap_address": { "type": "string" }, "imap_port": { "type": "string" }, "imap_enabled": { "type": "string" }, "imap_enable_ssl": { "type": "string" }, "smtp_login": { "type": "string" }, "smtp_password": { "type": "string" }, "smtp_address": { "type": "string" }, "smtp_port": { "type": "string" }, "smtp_enabled": { "type": "string" }, "smtp_domain": { "type": "string" }, "smtp_enable_ssl_tls": { "type": "string" }, "smtp_enable_starttls_auto": { "type": "string" }, "smtp_openssl_verify_mode": { "type": "string" }, "smtp_authentication": { "type": "string" }, "webhook_url": { "type": "string" }, "inbox_identifier": { "type": "string" }, "additional_attributes": { "type": "string" }, "provider": { "type": "string" }, "message_templates": { "type": "string" }, "provider_config": { "type": "string" }, "integrated_csat": { "type": "string" }, "consider_proactive_messages": { "type": "string" }, "integration_status": { "type": "string" }, "email_swap_channel_id": { "type": "string" }, "enable_swap_to_email_channel": { "type": "string" }, "dm_enabled": { "type": "string" }, "comments_enabled": { "type": "string" }, "stories_enabled": { "type": "string" }, "human_agent_enabled": { "type": "string" }, "human_agent_active": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_inboxes", "summary": "Delete Inboxes", "tags": [ "Inboxes" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inbox_configuration_events": { "post": { "operationId": "create_inbox_configuration_events", "summary": "Create Inbox Configuration Events", "tags": [ "Inbox Configuration Events" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "event_type": { "type": "string" }, "event_data": { "type": "object", "additionalProperties": true } }, "required": [ "event_type", "event_data" ] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inbox_members": { "delete": { "operationId": "destroy_inbox_members", "summary": "Delete Inbox Members", "tags": [ "Inbox Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_inbox_members", "summary": "Update Inbox Members", "tags": [ "Inbox Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_inbox_members", "summary": "Create Inbox Members", "tags": [ "Inbox Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/inbox_members/{inbox_id}": { "get": { "operationId": "show_inbox_members", "summary": "Get Inbox Members", "tags": [ "Inbox Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/labels/import": { "post": { "operationId": "import_labels", "summary": "Import Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } }, "required": [ "title" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/labels": { "get": { "operationId": "index_labels", "summary": "List Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_labels", "summary": "Create Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } }, "required": [ "title" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/labels/{id}": { "get": { "operationId": "show_labels", "summary": "Get Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_labels", "summary": "Update Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } }, "required": [ "title" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_labels", "summary": "Update Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } }, "required": [ "title" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "show_on_sidebar": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_labels", "summary": "Delete Labels", "tags": [ "Labels" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/response_sources/parse": { "post": { "operationId": "parse_response_sources", "summary": "Parse Response Sources", "tags": [ "Response Sources" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/response_sources/{id}/add_document": { "post": { "operationId": "add_document_response_sources", "summary": "Add Document Response Sources", "tags": [ "Response Sources" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "source_link": { "type": "string" }, "source_type": { "type": "string" }, "account_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "response_documents": { "type": "object" }, "document_link": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/response_sources/{id}/remove_document": { "post": { "operationId": "remove_document_response_sources", "summary": "Remove Document Response Sources", "tags": [ "Response Sources" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "source_link": { "type": "string" }, "source_type": { "type": "string" }, "account_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "response_documents": { "type": "object" }, "document_link": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/response_sources": { "post": { "operationId": "create_response_sources", "summary": "Create Response Sources", "tags": [ "Response Sources" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "source_link": { "type": "string" }, "source_type": { "type": "string" }, "account_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "response_documents": { "type": "object" }, "document_link": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notifications/read_all": { "post": { "operationId": "read_all_notifications", "summary": "Read All Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notifications/unread_count": { "get": { "operationId": "unread_count_notifications", "summary": "Unread Count Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notifications/destroy_all": { "post": { "operationId": "destroy_all_notifications", "summary": "Destroy All Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notifications/{id}/snooze": { "post": { "operationId": "snooze_notifications", "summary": "Snooze Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notifications/{id}/unread": { "post": { "operationId": "unread_notifications", "summary": "Unread Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notifications": { "get": { "operationId": "index_notifications", "summary": "List Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "unread_count": { "type": "string" }, "count": { "type": "string" }, "current_page": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "notification_type": { "type": "integer" }, "push_message_title": { "type": "string" }, "primary_actor_type": { "type": "string" }, "primary_actor_id": { "type": "integer", "format": "int64" }, "primary_actor": { "type": "string" }, "read_at": { "type": "string", "format": "date-time" }, "secondary_actor": { "type": "string" }, "user": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "last_activity_at": { "type": "string", "format": "date-time" }, "snoozed_until": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notifications/{id}": { "patch": { "operationId": "update_notifications", "summary": "Update Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_notifications", "summary": "Update Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_notifications", "summary": "Delete Notifications", "tags": [ "Notifications" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/notification_settings": { "get": { "operationId": "show_notification_settings", "summary": "Get Notification Settings", "tags": [ "Notification Settings" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "integer" }, "account_id": { "type": "integer" }, "all_email_flags": { "type": "string" }, "selected_email_flags": { "type": "string" }, "all_push_flags": { "type": "string" }, "selected_push_flags": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_notification_settings", "summary": "Update Notification Settings", "tags": [ "Notification Settings" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_notification_settings", "summary": "Update Notification Settings", "tags": [ "Notification Settings" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/teams/{team_id}/team_members": { "delete": { "operationId": "destroy_team_members", "summary": "Delete Team Members", "tags": [ "Team Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_team_members", "summary": "Update Team Members", "tags": [ "Team Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "get": { "operationId": "index_team_members", "summary": "List Team Members", "tags": [ "Team Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_team_members", "summary": "Create Team Members", "tags": [ "Team Members" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "confirmed": { "type": "string" }, "email": { "type": "string" }, "available_name": { "type": "string" }, "custom_attributes": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "assignment_limit": { "type": "string" }, "is_ai_agent": { "type": "string" }, "phone_number": { "type": "string" }, "thumbnail": { "type": "string" }, "team_ids": { "type": "string" }, "inbox_ids": { "type": "string" }, "availability_reason": { "type": "object" }, "reason": { "type": "string" }, "emoji": { "type": "string" }, "protected_from_deletion": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/teams": { "get": { "operationId": "index_teams", "summary": "List Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "boolean" }, "account_id": { "type": "integer", "format": "int64" }, "is_member": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "working_hours_enabled": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_teams", "summary": "Create Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "boolean" }, "account_id": { "type": "integer", "format": "int64" }, "is_member": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "working_hours_enabled": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/teams/new": { "get": { "operationId": "new_teams", "summary": "New Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/teams/{id}/edit": { "get": { "operationId": "edit_teams", "summary": "Edit Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/teams/{id}": { "get": { "operationId": "show_teams", "summary": "Get Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "boolean" }, "account_id": { "type": "integer", "format": "int64" }, "is_member": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "working_hours_enabled": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_teams", "summary": "Update Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "boolean" }, "account_id": { "type": "integer", "format": "int64" }, "is_member": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "working_hours_enabled": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_teams", "summary": "Update Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "allow_auto_assign": { "type": "boolean" }, "account_id": { "type": "integer", "format": "int64" }, "is_member": { "type": "string" }, "out_of_office_message": { "type": "string" }, "working_hours": { "type": "string" }, "timezone": { "type": "string" }, "working_hours_enabled": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_teams", "summary": "Delete Teams", "tags": [ "Teams" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/twitter/authorization": { "post": { "operationId": "twitter_create_authorizations", "summary": "Create Authorizations", "tags": [ "Authorizations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" }, "url": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/microsoft/authorization": { "post": { "operationId": "microsoft_create_authorizations", "summary": "Create Authorizations", "tags": [ "Authorizations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" }, "url": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/google/authorization": { "post": { "operationId": "google_create_authorizations", "summary": "Create Authorizations", "tags": [ "Authorizations" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" }, "url": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/webhooks": { "get": { "operationId": "index_webhooks", "summary": "List Webhooks", "tags": [ "Webhooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "webhooks": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_webhooks", "summary": "Create Webhooks", "tags": [ "Webhooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "webhook": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/webhooks/{id}": { "patch": { "operationId": "update_webhooks", "summary": "Update Webhooks", "tags": [ "Webhooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "webhook": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_webhooks", "summary": "Update Webhooks", "tags": [ "Webhooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" }, "webhook": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_webhooks", "summary": "Delete Webhooks", "tags": [ "Webhooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/apps": { "get": { "operationId": "integrations_index_apps", "summary": "List Apps", "tags": [ "Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "string" }, "action": { "type": "string" }, "button": { "type": "string" }, "hooks": { "type": "object" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/apps/{id}": { "get": { "operationId": "integrations_show_apps", "summary": "Get Apps", "tags": [ "Apps" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "string" }, "action": { "type": "string" }, "button": { "type": "string" }, "hooks": { "type": "object" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/captain/sso_url": { "get": { "operationId": "integrations_sso_url_captain", "summary": "Sso Url Captain", "tags": [ "Captain" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "sso_url": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/hooks/{id}/process_event": { "post": { "operationId": "integrations_process_event_hooks", "summary": "Process Event Hooks", "tags": [ "Hooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "app_id": { "type": "string" }, "inbox_id": { "type": "string" }, "status": { "type": "string" }, "settings": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/hooks": { "post": { "operationId": "integrations_create_hooks", "summary": "Create Hooks", "tags": [ "Hooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "app_id": { "type": "string" }, "inbox_id": { "type": "string" }, "status": { "type": "string" }, "settings": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/hooks/{id}": { "get": { "operationId": "integrations_show_hooks", "summary": "Get Hooks", "tags": [ "Hooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "integrations_update_hooks", "summary": "Update Hooks", "tags": [ "Hooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "app_id": { "type": "string" }, "inbox_id": { "type": "string" }, "status": { "type": "string" }, "settings": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "integrations_update_hooks", "summary": "Update Hooks", "tags": [ "Hooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "app_id": { "type": "string" }, "inbox_id": { "type": "string" }, "status": { "type": "string" }, "settings": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "integrations_destroy_hooks", "summary": "Delete Hooks", "tags": [ "Hooks" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/slack/list_all_channels": { "get": { "operationId": "integrations_list_all_channels_slack", "summary": "List All Channels Slack", "tags": [ "Slack" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/slack": { "patch": { "operationId": "integrations_update_slack", "summary": "Update Slack", "tags": [ "Slack" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reference_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "string" }, "action": { "type": "string" }, "button": { "type": "string" }, "hooks": { "type": "object" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "integrations_update_slack", "summary": "Update Slack", "tags": [ "Slack" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reference_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "string" }, "action": { "type": "string" }, "button": { "type": "string" }, "hooks": { "type": "object" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "integrations_destroy_slack", "summary": "Delete Slack", "tags": [ "Slack" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "integrations_create_slack", "summary": "Create Slack", "tags": [ "Slack" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reference_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "string" }, "action": { "type": "string" }, "button": { "type": "string" }, "hooks": { "type": "object" }, "app_id": { "type": "string" }, "status": { "type": "string" }, "inbox": { "type": "string" }, "account_id": { "type": "string" }, "hook_type": { "type": "string" }, "settings": { "type": "string" }, "reference_id": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/dyte/create_a_meeting": { "post": { "operationId": "integrations_create_a_meeting_dyte", "summary": "Create A Meeting Dyte", "tags": [ "Dyte" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "conversation_id": { "type": "string" }, "message_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/dyte/add_participant_to_meeting": { "post": { "operationId": "integrations_add_participant_to_meeting_dyte", "summary": "Add Participant To Meeting Dyte", "tags": [ "Dyte" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "conversation_id": { "type": "string" }, "message_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/projects": { "get": { "operationId": "integrations_projects_jira", "summary": "Projects Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/project_entities": { "get": { "operationId": "integrations_project_entities_jira", "summary": "Project Entities Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/assignable_users": { "get": { "operationId": "integrations_assignable_users_jira", "summary": "Assignable Users Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/create_issue": { "post": { "operationId": "integrations_create_issue_jira", "summary": "Create Issue Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "project_key": { "type": "string" }, "issue_type_id": { "type": "string" }, "conversation_id": { "type": "string" }, "issue_key": { "type": "string" }, "link_id": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "assignee_id": { "type": "string" }, "priority_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/link_issue": { "post": { "operationId": "integrations_link_issue_jira", "summary": "Link Issue Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "project_key": { "type": "string" }, "issue_type_id": { "type": "string" }, "conversation_id": { "type": "string" }, "issue_key": { "type": "string" }, "link_id": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "assignee_id": { "type": "string" }, "priority_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/unlink_issue": { "post": { "operationId": "integrations_unlink_issue_jira", "summary": "Unlink Issue Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "project_key": { "type": "string" }, "issue_type_id": { "type": "string" }, "conversation_id": { "type": "string" }, "issue_key": { "type": "string" }, "link_id": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "assignee_id": { "type": "string" }, "priority_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/search_issues": { "get": { "operationId": "integrations_search_issues_jira", "summary": "Search Issues Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/jira/linked_issues": { "get": { "operationId": "integrations_linked_issues_jira", "summary": "Linked Issues Jira", "tags": [ "Jira" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/linear/teams": { "get": { "operationId": "integrations_teams_linear", "summary": "Teams Linear", "tags": [ "Linear" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/linear/team_entities": { "get": { "operationId": "integrations_team_entities_linear", "summary": "Team Entities Linear", "tags": [ "Linear" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/linear/create_issue": { "post": { "operationId": "integrations_create_issue_linear", "summary": "Create Issue Linear", "tags": [ "Linear" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "team_id": { "type": "string" }, "project_id": { "type": "string" }, "conversation_id": { "type": "string" }, "issue_id": { "type": "string" }, "link_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "assignee_id": { "type": "string" }, "priority": { "type": "string" }, "label_ids": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/linear/link_issue": { "post": { "operationId": "integrations_link_issue_linear", "summary": "Link Issue Linear", "tags": [ "Linear" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "team_id": { "type": "string" }, "project_id": { "type": "string" }, "conversation_id": { "type": "string" }, "issue_id": { "type": "string" }, "link_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "assignee_id": { "type": "string" }, "priority": { "type": "string" }, "label_ids": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/linear/unlink_issue": { "post": { "operationId": "integrations_unlink_issue_linear", "summary": "Unlink Issue Linear", "tags": [ "Linear" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "team_id": { "type": "string" }, "project_id": { "type": "string" }, "conversation_id": { "type": "string" }, "issue_id": { "type": "string" }, "link_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "assignee_id": { "type": "string" }, "priority": { "type": "string" }, "label_ids": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/linear/search_issue": { "get": { "operationId": "integrations_search_issue_linear", "summary": "Search Issue Linear", "tags": [ "Linear" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/integrations/linear/linked_issues": { "get": { "operationId": "integrations_linked_issues_linear", "summary": "Linked Issues Linear", "tags": [ "Linear" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/working_hours/{id}": { "patch": { "operationId": "update_working_hours", "summary": "Update Working Hours", "tags": [ "Working Hours" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_working_hours", "summary": "Update Working Hours", "tags": [ "Working Hours" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{id}/archive": { "patch": { "operationId": "archive_portals", "summary": "Archive Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{id}/add_members": { "put": { "operationId": "add_members_portals", "summary": "Add Members Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{id}/logo": { "delete": { "operationId": "logo_portals", "summary": "Logo Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/categories/create_and_translate": { "post": { "operationId": "create_and_translate_categories", "summary": "Create And Translate Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/categories": { "get": { "operationId": "index_categories", "summary": "List Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "current_page": { "type": "string" }, "categories_count": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_categories", "summary": "Create Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "position": { "type": "integer" }, "slug": { "type": "string" }, "locale": { "type": "string" }, "icon": { "type": "string" }, "parent_category_id": { "type": "integer", "format": "int64" }, "associated_category_id": { "type": "integer", "format": "int64" } }, "required": [] } }, "required": [ "category" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/categories/new": { "get": { "operationId": "new_categories", "summary": "New Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/categories/{id}/edit": { "get": { "operationId": "edit_categories", "summary": "Edit Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/categories/{id}": { "get": { "operationId": "show_categories", "summary": "Get Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_categories", "summary": "Update Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "position": { "type": "integer" }, "slug": { "type": "string" }, "locale": { "type": "string" }, "icon": { "type": "string" }, "parent_category_id": { "type": "integer", "format": "int64" }, "associated_category_id": { "type": "integer", "format": "int64" } }, "required": [] } }, "required": [ "category" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_categories", "summary": "Update Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "position": { "type": "integer" }, "slug": { "type": "string" }, "locale": { "type": "string" }, "icon": { "type": "string" }, "parent_category_id": { "type": "integer", "format": "int64" }, "associated_category_id": { "type": "integer", "format": "int64" } }, "required": [] } }, "required": [ "category" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_categories", "summary": "Delete Categories", "tags": [ "Categories" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles/reorder": { "post": { "operationId": "reorder_articles", "summary": "Reorder Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles/find_by_associated_article_id": { "get": { "operationId": "find_by_associated_article_id_articles", "summary": "Find By Associated Article Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "parameters": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles/create_and_translate": { "post": { "operationId": "create_and_translate_articles", "summary": "Create And Translate Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles/{id}/update_and_translate": { "patch": { "operationId": "update_and_translate_articles", "summary": "Update And Translate Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles": { "get": { "operationId": "index_articles", "summary": "List Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "all_articles_count": { "type": "string" }, "archived_articles_count": { "type": "string" }, "articles_count": { "type": "string" }, "current_page": { "type": "string" }, "draft_articles_count": { "type": "string" }, "mine_articles_count": { "type": "string" }, "published_count": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_articles", "summary": "Create Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "article": { "type": "object", "properties": { "title": { "type": "string" }, "slug": { "type": "string" }, "position": { "type": "integer" }, "content": { "type": "string" }, "description": { "type": "string" }, "category_id": { "type": "integer" }, "author_id": { "type": "integer", "format": "int64" }, "associated_article_id": { "type": "integer", "format": "int64" }, "status": { "type": "integer" }, "meta": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [] } }, "required": [ "article" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles/new": { "get": { "operationId": "new_articles", "summary": "New Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles/{id}/edit": { "get": { "operationId": "edit_articles", "summary": "Edit Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{portal_id}/articles/{id}": { "get": { "operationId": "show_articles", "summary": "Get Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_articles", "summary": "Update Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "article": { "type": "object", "properties": { "title": { "type": "string" }, "slug": { "type": "string" }, "position": { "type": "integer" }, "content": { "type": "string" }, "description": { "type": "string" }, "category_id": { "type": "integer" }, "author_id": { "type": "integer", "format": "int64" }, "associated_article_id": { "type": "integer", "format": "int64" }, "status": { "type": "integer" }, "meta": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [] } }, "required": [ "article" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_articles", "summary": "Update Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "article": { "type": "object", "properties": { "title": { "type": "string" }, "slug": { "type": "string" }, "position": { "type": "integer" }, "content": { "type": "string" }, "description": { "type": "string" }, "category_id": { "type": "integer" }, "author_id": { "type": "integer", "format": "int64" }, "associated_article_id": { "type": "integer", "format": "int64" }, "status": { "type": "integer" }, "meta": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [] } }, "required": [ "article" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_articles", "summary": "Delete Articles", "tags": [ "Articles" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "portal_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals": { "get": { "operationId": "index_portals", "summary": "List Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "current_page": { "type": "string" }, "portals_count": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_portals", "summary": "Create Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "portal": { "type": "object", "properties": { "account_id": { "type": "integer" }, "color": { "type": "string" }, "custom_domain": { "type": "string" }, "header_text": { "type": "string" }, "homepage_link": { "type": "string" }, "name": { "type": "string" }, "page_title": { "type": "string" }, "slug": { "type": "string" }, "archived": { "type": "boolean" }, "channel_web_widget_id": { "type": "integer", "format": "int64" }, "is_public": { "type": "boolean" }, "config": { "type": "array", "items": { "type": "object", "properties": { "default_locale": { "type": "string" } } } }, "allowed_locales": { "type": "array", "items": { "type": "string" } } }, "required": [] } }, "required": [ "portal" ] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/new": { "get": { "operationId": "new_portals", "summary": "New Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{id}/edit": { "get": { "operationId": "edit_portals", "summary": "Edit Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/portals/{id}": { "get": { "operationId": "show_portals", "summary": "Get Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_portals", "summary": "Update Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "portal": { "type": "object", "properties": { "account_id": { "type": "integer" }, "color": { "type": "string" }, "custom_domain": { "type": "string" }, "header_text": { "type": "string" }, "homepage_link": { "type": "string" }, "name": { "type": "string" }, "page_title": { "type": "string" }, "slug": { "type": "string" }, "archived": { "type": "boolean" }, "channel_web_widget_id": { "type": "integer", "format": "int64" }, "is_public": { "type": "boolean" }, "config": { "type": "array", "items": { "type": "object", "properties": { "default_locale": { "type": "string" } } } }, "allowed_locales": { "type": "array", "items": { "type": "string" } } }, "required": [] } }, "required": [ "portal" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_portals", "summary": "Update Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "portal": { "type": "object", "properties": { "account_id": { "type": "integer" }, "color": { "type": "string" }, "custom_domain": { "type": "string" }, "header_text": { "type": "string" }, "homepage_link": { "type": "string" }, "name": { "type": "string" }, "page_title": { "type": "string" }, "slug": { "type": "string" }, "archived": { "type": "boolean" }, "channel_web_widget_id": { "type": "integer", "format": "int64" }, "is_public": { "type": "boolean" }, "config": { "type": "array", "items": { "type": "object", "properties": { "default_locale": { "type": "string" } } } }, "allowed_locales": { "type": "array", "items": { "type": "string" } } }, "required": [] } }, "required": [ "portal" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_portals", "summary": "Delete Portals", "tags": [ "Portals" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts/{account_id}/upload": { "post": { "operationId": "create_upload", "summary": "Create Upload", "tags": [ "Upload" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "external_url": { "type": "string" }, "attachment_base64": { "type": "string" }, "filename": { "type": "string" }, "content_type": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/accounts": { "post": { "operationId": "create_accounts", "summary": "Create Accounts", "tags": [ "Accounts" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "provider": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "email": { "type": "string" }, "account_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "pubsub_token": { "type": "string" }, "role": { "type": "string" }, "inviter_id": { "type": "string" }, "confirmed": { "type": "string" }, "avatar_url": { "type": "string" }, "access_token": { "type": "string" }, "accounts": { "type": "array", "items": { "type": "object" } }, "active_at": { "type": "string" }, "locale": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/accounts/{id}": { "get": { "operationId": "show_accounts", "summary": "Get Accounts", "tags": [ "Accounts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "auto_resolve_duration": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "custom_attributes": { "type": "object" }, "plan_name": { "type": "string" }, "subscribed_quantity": { "type": "string" }, "subscription_status": { "type": "string" }, "subscription_ends_on": { "type": "string" }, "industry": { "type": "string" }, "company_size": { "type": "string" }, "logo": { "type": "string" }, "onboarding_step": { "type": "string" }, "auto_refresh_interval": { "type": "integer" }, "timezone": { "type": "string" }, "domain": { "type": "string" }, "features": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "integer" }, "name": { "type": "string" }, "support_email": { "type": "string" }, "status": { "type": "integer" }, "cache_keys": { "type": "string" }, "assignment_limit": { "type": "integer" }, "claudia_takeover_allowed_roles": { "type": "string" }, "latest_chatwoot_version": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_accounts", "summary": "Update Accounts", "tags": [ "Accounts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "auto_resolve_duration": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "custom_attributes": { "type": "object" }, "plan_name": { "type": "string" }, "subscribed_quantity": { "type": "string" }, "subscription_status": { "type": "string" }, "subscription_ends_on": { "type": "string" }, "industry": { "type": "string" }, "company_size": { "type": "string" }, "logo": { "type": "string" }, "onboarding_step": { "type": "string" }, "auto_refresh_interval": { "type": "integer" }, "timezone": { "type": "string" }, "domain": { "type": "string" }, "features": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "integer" }, "name": { "type": "string" }, "support_email": { "type": "string" }, "status": { "type": "integer" }, "cache_keys": { "type": "string" }, "assignment_limit": { "type": "integer" }, "claudia_takeover_allowed_roles": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_accounts", "summary": "Update Accounts", "tags": [ "Accounts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "auto_resolve_duration": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "custom_attributes": { "type": "object" }, "plan_name": { "type": "string" }, "subscribed_quantity": { "type": "string" }, "subscription_status": { "type": "string" }, "subscription_ends_on": { "type": "string" }, "industry": { "type": "string" }, "company_size": { "type": "string" }, "logo": { "type": "string" }, "onboarding_step": { "type": "string" }, "auto_refresh_interval": { "type": "integer" }, "timezone": { "type": "string" }, "domain": { "type": "string" }, "features": { "type": "string" }, "id": { "type": "string" }, "locale": { "type": "integer" }, "name": { "type": "string" }, "support_email": { "type": "string" }, "status": { "type": "integer" }, "cache_keys": { "type": "string" }, "assignment_limit": { "type": "integer" }, "claudia_takeover_allowed_roles": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/integrations/webhooks": { "post": { "operationId": "integrations_create_webhooks", "summary": "Create Webhooks", "tags": [ "Webhooks" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile/avatar": { "delete": { "operationId": "avatar_profiles", "summary": "Avatar Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile/availability": { "post": { "operationId": "availability_profiles", "summary": "Availability Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "account_id": { "type": "string" }, "availability": { "type": "string" }, "availability_reason_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile/auto_offline": { "post": { "operationId": "auto_offline_profiles", "summary": "Auto Offline Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "account_id": { "type": "string" }, "auto_offline": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile/set_active_account": { "put": { "operationId": "set_active_account_profiles", "summary": "Set Active Account Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile/resend_confirmation": { "post": { "operationId": "resend_confirmation_profiles", "summary": "Resend Confirmation Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile/regenerate_token": { "post": { "operationId": "regenerate_token_profiles", "summary": "Regenerate Token Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile/instances": { "get": { "operationId": "instances_profiles", "summary": "Instances Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/profile": { "get": { "operationId": "show_profiles", "summary": "Get Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_id": { "type": "string" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "string" }, "display_name": { "type": "string" }, "message_signature": { "type": "string" }, "email": { "type": "string" }, "hmac_identifier": { "type": "string" }, "id": { "type": "string" }, "inviter_id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "account_user_custom_attributes": { "type": "string" }, "ui_settings": { "type": "string" }, "uid": { "type": "string" }, "type": { "type": "string" }, "cognito_access_token": { "type": "string" }, "eddie_base_url": { "type": "string" }, "accounts": { "type": "object" }, "status": { "type": "string" }, "active_at": { "type": "string" }, "permissions": { "type": "string" }, "availability": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "availability_reason": { "type": "string" }, "reason": { "type": "string" }, "emoji": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } }, "patch": { "operationId": "update_profiles", "summary": "Update Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_id": { "type": "string" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "string" }, "display_name": { "type": "string" }, "message_signature": { "type": "string" }, "email": { "type": "string" }, "hmac_identifier": { "type": "string" }, "id": { "type": "string" }, "inviter_id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "account_user_custom_attributes": { "type": "string" }, "ui_settings": { "type": "string" }, "uid": { "type": "string" }, "type": { "type": "string" }, "cognito_access_token": { "type": "string" }, "eddie_base_url": { "type": "string" }, "accounts": { "type": "object" }, "status": { "type": "string" }, "active_at": { "type": "string" }, "permissions": { "type": "string" }, "availability": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "availability_reason": { "type": "string" }, "reason": { "type": "string" }, "emoji": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } }, "put": { "operationId": "update_profiles", "summary": "Update Profiles", "tags": [ "Profiles" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_id": { "type": "string" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "string" }, "display_name": { "type": "string" }, "message_signature": { "type": "string" }, "email": { "type": "string" }, "hmac_identifier": { "type": "string" }, "id": { "type": "string" }, "inviter_id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "custom_attributes": { "type": "string" }, "role": { "type": "string" }, "account_user_custom_attributes": { "type": "string" }, "ui_settings": { "type": "string" }, "uid": { "type": "string" }, "type": { "type": "string" }, "cognito_access_token": { "type": "string" }, "eddie_base_url": { "type": "string" }, "accounts": { "type": "object" }, "status": { "type": "string" }, "active_at": { "type": "string" }, "permissions": { "type": "string" }, "availability": { "type": "string" }, "availability_status": { "type": "string" }, "auto_offline": { "type": "string" }, "availability_reason": { "type": "string" }, "reason": { "type": "string" }, "emoji": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/notification_subscriptions": { "delete": { "operationId": "destroy_notification_subscriptions", "summary": "Delete Notification Subscriptions", "tags": [ "Notification Subscriptions" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } }, "post": { "operationId": "create_notification_subscriptions", "summary": "Create Notification Subscriptions", "tags": [ "Notification Subscriptions" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/direct_uploads": { "post": { "operationId": "create_direct_uploads", "summary": "Create Direct Uploads", "tags": [ "Widget::Direct Uploads" ], "security": [], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/config": { "post": { "operationId": "create_configs", "summary": "Create Configs", "tags": [ "Widget::Configs" ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "website_channel_config": { "type": "object" }, "allow_messages_after_resolved": { "type": "string" }, "api_host": { "type": "string" }, "auth_token": { "type": "string" }, "avatar_url": { "type": "string" }, "csat_survey_enabled": { "type": "string" }, "disable_branding": { "type": "string" }, "enabled_features": { "type": "string" }, "enabled_languages": { "type": "string" }, "locale": { "type": "string" }, "out_of_office_message": { "type": "string" }, "portal": { "type": "string" }, "pre_chat_form_enabled": { "type": "string" }, "pre_chat_form_options": { "type": "string" }, "reply_time": { "type": "string" }, "timezone": { "type": "string" }, "utc_off_set": { "type": "string" }, "website_name": { "type": "string" }, "website_token": { "type": "string" }, "welcome_tagline": { "type": "string" }, "welcome_title": { "type": "string" }, "widget_color": { "type": "string" }, "working_hours": { "type": "string" }, "working_hours_enabled": { "type": "string" }, "contact": { "type": "object" }, "email": { "type": "string" }, "id": { "type": "string" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "pubsub_token": { "type": "string" }, "global_config": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/campaigns": { "get": { "operationId": "index_campaigns", "summary": "List Campaigns", "tags": [ "Widget::Campaigns" ], "security": [], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "trigger_rules": { "type": "object" }, "trigger_only_during_business_hours": { "type": "boolean" }, "message": { "type": "string" }, "sender": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/events": { "post": { "operationId": "create_events", "summary": "Create Events", "tags": [ "Widget::Events" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "website_token": { "type": "string" }, "event_info": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/messages": { "get": { "operationId": "index_messages", "summary": "List Messages", "tags": [ "Widget::Messages" ], "security": [], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "content": { "type": "string" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "content_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "integer" }, "attachments": { "type": "string" }, "sender": { "type": "string" }, "meta": { "type": "object" }, "contact_last_seen_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } }, "post": { "operationId": "create_messages", "summary": "Create Messages", "tags": [ "Widget::Messages" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "before": { "type": "string" }, "after": { "type": "string" }, "website_token": { "type": "string" }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" }, "reply_to": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "inbox_id": { "type": "integer" }, "conversation_id": { "type": "integer" }, "message_type": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "private": { "type": "boolean" }, "source_id": { "type": "string" }, "content_attributes": { "type": "object" }, "attachments": { "type": "string" }, "sender": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/messages/{id}": { "patch": { "operationId": "update_messages", "summary": "Update Messages", "tags": [ "Widget::Messages" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "before": { "type": "string" }, "after": { "type": "string" }, "website_token": { "type": "string" }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" }, "reply_to": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "contact": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_messages", "summary": "Update Messages", "tags": [ "Widget::Messages" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "before": { "type": "string" }, "after": { "type": "string" }, "website_token": { "type": "string" }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" }, "reply_to": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "contact": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/widget/multi_messages": { "post": { "operationId": "create_multi_messages", "summary": "Create Multi Messages", "tags": [ "Widget::Multi Messages" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "conversation_id": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" }, "reply_to": { "type": "string" } } } }, "attachments": { "type": "array", "items": { "type": "string" } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/multi_conversations/toggle_typing": { "post": { "operationId": "toggle_typing_multi_conversations", "summary": "Toggle Typing Multi Conversations", "tags": [ "Widget::Multi Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "typing_status": { "type": "string" }, "conversation_id": { "type": "string" }, "cw_conversation": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } }, "multi_conversation": { "type": "array", "items": { "type": "object", "properties": { "conversation_id": { "type": "string" }, "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/multi_conversations/toggle_status": { "post": { "operationId": "toggle_status_multi_conversations", "summary": "Toggle Status Multi Conversations", "tags": [ "Widget::Multi Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "typing_status": { "type": "string" }, "conversation_id": { "type": "string" }, "cw_conversation": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } }, "multi_conversation": { "type": "array", "items": { "type": "object", "properties": { "conversation_id": { "type": "string" }, "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/multi_conversations/update_last_seen": { "post": { "operationId": "update_last_seen_multi_conversations", "summary": "Update Last Seen Multi Conversations", "tags": [ "Widget::Multi Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "typing_status": { "type": "string" }, "conversation_id": { "type": "string" }, "cw_conversation": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } }, "multi_conversation": { "type": "array", "items": { "type": "object", "properties": { "conversation_id": { "type": "string" }, "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/multi_conversations": { "post": { "operationId": "create_multi_conversations", "summary": "Create Multi Conversations", "tags": [ "Widget::Multi Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "typing_status": { "type": "string" }, "conversation_id": { "type": "string" }, "cw_conversation": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } }, "multi_conversation": { "type": "array", "items": { "type": "object", "properties": { "conversation_id": { "type": "string" }, "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" } } } } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/destroy_custom_attributes": { "post": { "operationId": "destroy_custom_attributes_conversations", "summary": "Destroy Custom Attributes Conversations", "tags": [ "Widget::Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "typing_status": { "type": "string" }, "website_token": { "type": "string" }, "email": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } } }, "required": [ "contact" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/set_custom_attributes": { "post": { "operationId": "set_custom_attributes_conversations", "summary": "Set Custom Attributes Conversations", "tags": [ "Widget::Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "typing_status": { "type": "string" }, "website_token": { "type": "string" }, "email": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } } }, "required": [ "contact" ] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/update_last_seen": { "post": { "operationId": "update_last_seen_conversations", "summary": "Update Last Seen Conversations", "tags": [ "Widget::Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "typing_status": { "type": "string" }, "website_token": { "type": "string" }, "email": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } } }, "required": [ "contact" ] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/toggle_typing": { "post": { "operationId": "toggle_typing_conversations", "summary": "Toggle Typing Conversations", "tags": [ "Widget::Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "typing_status": { "type": "string" }, "website_token": { "type": "string" }, "email": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } } }, "required": [ "contact" ] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/transcript": { "post": { "operationId": "transcript_conversations", "summary": "Transcript Conversations", "tags": [ "Widget::Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "typing_status": { "type": "string" }, "website_token": { "type": "string" }, "email": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } } }, "required": [ "contact" ] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/messages": { "get": { "operationId": "messages_conversations", "summary": "Messages Conversations", "tags": [ "Widget::Conversations" ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "string" }, "meta": { "type": "string" }, "contact_last_seen_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/active": { "get": { "operationId": "active_conversations", "summary": "Active Conversations", "tags": [ "Widget::Conversations" ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "display_id": { "type": "integer" }, "conversation_id": { "type": "string" }, "inbox_id": { "type": "integer" }, "messages": { "type": "string" }, "labels": { "type": "string" }, "meta": { "type": "string" }, "status": { "type": "integer" }, "custom_attributes": { "type": "object" }, "snoozed_until": { "type": "string", "format": "date-time" }, "unread_count": { "type": "string" }, "first_reply_created_at": { "type": "string", "format": "date-time" }, "priority": { "type": "integer" }, "waiting_since": { "type": "string", "format": "date-time" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "last_activity_at": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/history": { "get": { "operationId": "history_conversations", "summary": "History Conversations", "tags": [ "Widget::Conversations" ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "string" }, "list": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" }, "assignee": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "display_id": { "type": "integer" }, "uuid": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "messages": { "type": "array", "items": { "type": "object" } }, "content": { "type": "string" }, "message_type": { "type": "string" }, "account_id": { "type": "integer" }, "inbox_id": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations/toggle_status": { "get": { "operationId": "toggle_status_conversations", "summary": "Toggle Status Conversations", "tags": [ "Widget::Conversations" ], "security": [], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/conversations": { "get": { "operationId": "index_conversations", "summary": "List Conversations", "tags": [ "Widget::Conversations" ], "security": [], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "inbox_id": { "type": "integer" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "additional_attributes": { "type": "object" } } } } } }, "401": { "description": "Unauthorized" } } }, "post": { "operationId": "create_conversations", "summary": "Create Conversations", "tags": [ "Widget::Conversations" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "typing_status": { "type": "string" }, "website_token": { "type": "string" }, "email": { "type": "string" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "contact": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } }, "message": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "referer_url": { "type": "string" }, "timestamp": { "type": "string" }, "echo_id": { "type": "string" } } } } }, "required": [ "contact" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "inbox_id": { "type": "integer" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "messages": { "type": "array", "items": { "type": "object" } }, "content": { "type": "string" }, "message_type": { "type": "string" }, "content_type": { "type": "string" }, "content_attributes": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "string" }, "attachments": { "type": "string" }, "sender": { "type": "string" }, "custom_attributes": { "type": "object" }, "contact": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/contact/destroy_custom_attributes": { "post": { "operationId": "destroy_custom_attributes_contacts", "summary": "Destroy Custom Attributes Contacts", "tags": [ "Widget::Contacts" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "additional_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/contact/set_user": { "patch": { "operationId": "set_user_contacts", "summary": "Set User Contacts", "tags": [ "Widget::Contacts" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "additional_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "has_email": { "type": "string" }, "has_name": { "type": "string" }, "has_phone_number": { "type": "string" }, "widget_auth_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/contact": { "get": { "operationId": "show_contacts", "summary": "Get Contacts", "tags": [ "Widget::Contacts" ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "has_email": { "type": "string" }, "has_name": { "type": "string" }, "has_phone_number": { "type": "string" }, "identifier": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } }, "patch": { "operationId": "update_contacts", "summary": "Update Contacts", "tags": [ "Widget::Contacts" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "additional_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "has_email": { "type": "string" }, "has_name": { "type": "string" }, "has_phone_number": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } }, "put": { "operationId": "update_contacts", "summary": "Update Contacts", "tags": [ "Widget::Contacts" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "custom_attributes": { "type": "object", "additionalProperties": true }, "additional_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "has_email": { "type": "string" }, "has_name": { "type": "string" }, "has_phone_number": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/inbox_members": { "get": { "operationId": "index_inbox_members", "summary": "List Inbox Members", "tags": [ "Widget::Inbox Members" ], "security": [], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "availability_status": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/labels": { "post": { "operationId": "create_labels", "summary": "Create Labels", "tags": [ "Widget::Labels" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "website_token": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/api/v1/widget/labels/{id}": { "delete": { "operationId": "destroy_labels", "summary": "Delete Labels", "tags": [ "Widget::Labels" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v1/widget/integrations/dyte/add_participant_to_meeting": { "post": { "operationId": "integrations_add_participant_to_meeting_dyte", "summary": "Add Participant To Meeting Dyte", "tags": [ "Widget::Dyte" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "website_token": { "type": "string" }, "message_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v2/accounts/{account_id}/summary_reports/agent": { "get": { "operationId": "agent_summary_reports", "summary": "Agent Summary Reports", "tags": [ "V2::Summary Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/summary_reports/team": { "get": { "operationId": "team_summary_reports", "summary": "Team Summary Reports", "tags": [ "V2::Summary Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/summary": { "get": { "operationId": "summary_reports", "summary": "Summary Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/bot_summary": { "get": { "operationId": "bot_summary_reports", "summary": "Bot Summary Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/agents": { "get": { "operationId": "agents_reports", "summary": "Agents Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/inboxes": { "get": { "operationId": "inboxes_reports", "summary": "Inboxes Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/labels": { "get": { "operationId": "labels_reports", "summary": "Labels Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/teams": { "get": { "operationId": "teams_reports", "summary": "Teams Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/conversations": { "get": { "operationId": "conversations_reports", "summary": "Conversations Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/conversation_traffic": { "get": { "operationId": "conversation_traffic_reports", "summary": "Conversation Traffic Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/bot_metrics": { "get": { "operationId": "bot_metrics_reports", "summary": "Bot Metrics Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports/inbox_metrics": { "get": { "operationId": "inbox_metrics_reports", "summary": "Inbox Metrics Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/reports": { "get": { "operationId": "index_reports", "summary": "List Reports", "tags": [ "V2::Reports" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/data_extracts": { "get": { "operationId": "index_data_extracts", "summary": "List Data Extracts", "tags": [ "V2::Data Extracts" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "parameters": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/integrations/explo/sign_in": { "post": { "operationId": "integrations_sign_in_explo", "summary": "Sign In Explo", "tags": [ "V2::Explo" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/integrations/omni/generate_url": { "post": { "operationId": "integrations_generate_url_omni", "summary": "Generate Url Omni", "tags": [ "V2::Omni" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts/{account_id}/integrations/omni/generate_create_mode_url": { "post": { "operationId": "integrations_generate_create_mode_url_omni", "summary": "Generate Create Mode Url Omni", "tags": [ "V2::Omni" ], "security": [ { "userApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/v2/accounts": { "post": { "operationId": "create_accounts", "summary": "Create Accounts", "tags": [ "V2::Accounts" ], "security": [ { "userApiKey": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/platform/api/v1/users/{id}/login": { "get": { "operationId": "login_users", "summary": "Login Users", "tags": [ "Platform::Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/platform/api/v1/users": { "post": { "operationId": "create_users", "summary": "Create Users", "tags": [ "Platform::Users" ], "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_id": { "type": "string" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "string" }, "display_name": { "type": "string" }, "message_signature": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "custom_attributes": { "type": "object" }, "role": { "type": "string" }, "ui_settings": { "type": "object" }, "uid": { "type": "string" }, "accounts": { "type": "object" }, "active_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/platform/api/v1/users/{id}": { "get": { "operationId": "show_users", "summary": "Get Users", "tags": [ "Platform::Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_id": { "type": "string" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "string" }, "display_name": { "type": "string" }, "message_signature": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "custom_attributes": { "type": "object" }, "role": { "type": "string" }, "ui_settings": { "type": "object" }, "uid": { "type": "string" }, "accounts": { "type": "object" }, "active_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_users", "summary": "Update Users", "tags": [ "Platform::Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_id": { "type": "string" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "string" }, "display_name": { "type": "string" }, "message_signature": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "custom_attributes": { "type": "object" }, "role": { "type": "string" }, "ui_settings": { "type": "object" }, "uid": { "type": "string" }, "accounts": { "type": "object" }, "active_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_users", "summary": "Update Users", "tags": [ "Platform::Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "account_id": { "type": "string" }, "available_name": { "type": "string" }, "avatar_url": { "type": "string" }, "confirmed": { "type": "string" }, "display_name": { "type": "string" }, "message_signature": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "pubsub_token": { "type": "string" }, "custom_attributes": { "type": "object" }, "role": { "type": "string" }, "ui_settings": { "type": "object" }, "uid": { "type": "string" }, "accounts": { "type": "object" }, "active_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_users", "summary": "Delete Users", "tags": [ "Platform::Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/platform/api/v1/agent_bots/{id}/avatar": { "delete": { "operationId": "avatar_agent_bots", "summary": "Avatar Agent Bots", "tags": [ "Platform::Agent Bots" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/platform/api/v1/agent_bots": { "get": { "operationId": "index_agent_bots", "summary": "List Agent Bots", "tags": [ "Platform::Agent Bots" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } }, "post": { "operationId": "create_agent_bots", "summary": "Create Agent Bots", "tags": [ "Platform::Agent Bots" ], "security": [ { "platformAppApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/platform/api/v1/agent_bots/{id}": { "get": { "operationId": "show_agent_bots", "summary": "Get Agent Bots", "tags": [ "Platform::Agent Bots" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_agent_bots", "summary": "Update Agent Bots", "tags": [ "Platform::Agent Bots" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_agent_bots", "summary": "Update Agent Bots", "tags": [ "Platform::Agent Bots" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "outgoing_url": { "type": "string" }, "account_id": { "type": "integer", "format": "int64" }, "access_token": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_agent_bots", "summary": "Delete Agent Bots", "tags": [ "Platform::Agent Bots" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/platform/api/v1/accounts/{account_id}/account_users": { "delete": { "operationId": "destroy_account_users", "summary": "Delete Account Users", "tags": [ "Platform::Account Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "get": { "operationId": "index_account_users", "summary": "List Account Users", "tags": [ "Platform::Account Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "create_account_users", "summary": "Create Account Users", "tags": [ "Platform::Account Users" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/platform/api/v1/accounts": { "post": { "operationId": "create_accounts", "summary": "Create Accounts", "tags": [ "Platform::Accounts" ], "security": [ { "platformAppApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "locale": { "type": "string", "enum": [ "en", "es", "pt_BR" ] }, "domain": { "type": "string", "maxLength": 100 }, "support_email": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "features": { "type": "object", "additionalProperties": true }, "limits": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "locale": { "type": "integer" }, "domain": { "type": "string" }, "support_email": { "type": "string" }, "features": { "type": "string" }, "custom_attributes": { "type": "object" }, "limits": { "type": "object" }, "status": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" } } } }, "/platform/api/v1/accounts/{id}": { "get": { "operationId": "show_accounts", "summary": "Get Accounts", "tags": [ "Platform::Accounts" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "locale": { "type": "integer" }, "domain": { "type": "string" }, "support_email": { "type": "string" }, "features": { "type": "string" }, "custom_attributes": { "type": "object" }, "limits": { "type": "object" }, "status": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_accounts", "summary": "Update Accounts", "tags": [ "Platform::Accounts" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "locale": { "type": "string", "enum": [ "en", "es", "pt_BR" ] }, "domain": { "type": "string", "maxLength": 100 }, "support_email": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "features": { "type": "object", "additionalProperties": true }, "limits": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "locale": { "type": "integer" }, "domain": { "type": "string" }, "support_email": { "type": "string" }, "features": { "type": "string" }, "custom_attributes": { "type": "object" }, "limits": { "type": "object" }, "status": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_accounts", "summary": "Update Accounts", "tags": [ "Platform::Accounts" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "locale": { "type": "string", "enum": [ "en", "es", "pt_BR" ] }, "domain": { "type": "string", "maxLength": 100 }, "support_email": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "features": { "type": "object", "additionalProperties": true }, "limits": { "type": "object", "additionalProperties": true }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "locale": { "type": "integer" }, "domain": { "type": "string" }, "support_email": { "type": "string" }, "features": { "type": "string" }, "custom_attributes": { "type": "object" }, "limits": { "type": "object" }, "status": { "type": "integer" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_accounts", "summary": "Delete Accounts", "tags": [ "Platform::Accounts" ], "security": [ { "platformAppApiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{contact_id}/conversations/{id}/toggle_status": { "post": { "operationId": "inboxes_toggle_status_conversations", "summary": "Toggle Status Conversations", "tags": [ "Public::Conversations" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "inbox_id": { "type": "integer" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "messages": { "type": "object" }, "content": { "type": "string" }, "message_type": { "type": "string" }, "content_type": { "type": "string" }, "content_attributes": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "string" }, "attachments": { "type": "string" }, "sender": { "type": "string" }, "contact": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{contact_id}/conversations/{id}/toggle_typing": { "post": { "operationId": "inboxes_toggle_typing_conversations", "summary": "Toggle Typing Conversations", "tags": [ "Public::Conversations" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{contact_id}/conversations/{id}/update_last_seen": { "post": { "operationId": "inboxes_update_last_seen_conversations", "summary": "Update Last Seen Conversations", "tags": [ "Public::Conversations" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{contact_id}/conversations/{conversation_id}/messages": { "get": { "operationId": "inboxes_index_messages", "summary": "List Messages", "tags": [ "Public::Messages" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "content_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "integer" }, "attachments": { "type": "string" }, "sender": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "inboxes_create_messages", "summary": "Create Messages", "tags": [ "Public::Messages" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "content": { "type": "string", "maxLength": 150000 }, "echo_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "content_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "integer" }, "attachments": { "type": "string" }, "sender": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{contact_id}/conversations/{conversation_id}/messages/{id}": { "patch": { "operationId": "inboxes_update_messages", "summary": "Update Messages", "tags": [ "Public::Messages" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "content": { "type": "string", "maxLength": 150000 }, "echo_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "content_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "integer" }, "attachments": { "type": "string" }, "sender": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "inboxes_update_messages", "summary": "Update Messages", "tags": [ "Public::Messages" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "content": { "type": "string", "maxLength": 150000 }, "echo_id": { "type": "string" } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "message_type": { "type": "integer" }, "content_type": { "type": "integer" }, "content_attributes": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "integer" }, "attachments": { "type": "string" }, "sender": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{contact_id}/conversations": { "get": { "operationId": "inboxes_index_conversations", "summary": "List Conversations", "tags": [ "Public::Conversations" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "inbox_id": { "type": "integer" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "messages": { "type": "object" }, "content": { "type": "string" }, "message_type": { "type": "string" }, "content_type": { "type": "string" }, "content_attributes": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "string" }, "attachments": { "type": "string" }, "sender": { "type": "string" }, "contact": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "inboxes_create_conversations", "summary": "Create Conversations", "tags": [ "Public::Conversations" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "inbox_id": { "type": "integer" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "messages": { "type": "object" }, "content": { "type": "string" }, "message_type": { "type": "string" }, "content_type": { "type": "string" }, "content_attributes": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "string" }, "attachments": { "type": "string" }, "sender": { "type": "string" }, "contact": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{contact_id}/conversations/{id}": { "get": { "operationId": "inboxes_show_conversations", "summary": "Get Conversations", "tags": [ "Public::Conversations" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "inbox_id": { "type": "integer" }, "contact_last_seen_at": { "type": "string", "format": "date-time" }, "status": { "type": "integer" }, "agent_last_seen_at": { "type": "string", "format": "date-time" }, "messages": { "type": "object" }, "content": { "type": "string" }, "message_type": { "type": "string" }, "content_type": { "type": "string" }, "content_attributes": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "conversation_id": { "type": "string" }, "attachments": { "type": "string" }, "sender": { "type": "string" }, "contact": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts": { "post": { "operationId": "inboxes_create_contacts", "summary": "Create Contacts", "tags": [ "Public::Contacts" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "source_id": { "type": "string" }, "pubsub_token": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{inbox_id}/contacts/{id}": { "get": { "operationId": "inboxes_show_contacts", "summary": "Get Contacts", "tags": [ "Public::Contacts" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "source_id": { "type": "string" }, "pubsub_token": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "inboxes_update_contacts", "summary": "Update Contacts", "tags": [ "Public::Contacts" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "source_id": { "type": "string" }, "pubsub_token": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "inboxes_update_contacts", "summary": "Update Contacts", "tags": [ "Public::Contacts" ], "security": [], "parameters": [ { "name": "inbox_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "identifier": { "type": "string" }, "identifier_hash": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "avatar_url": { "type": "string" }, "phone_number": { "type": "string", "format": "phone", "pattern": "\\+[1-9]\\d{1,14}\\z" }, "custom_attributes": { "type": "object", "additionalProperties": true } }, "required": [] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "source_id": { "type": "string" }, "pubsub_token": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes": { "get": { "operationId": "index_inboxes", "summary": "List Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } }, "post": { "operationId": "create_inboxes", "summary": "Create Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/public/api/v1/inboxes/new": { "get": { "operationId": "new_inboxes", "summary": "New Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" } } } }, "/public/api/v1/inboxes/{id}/edit": { "get": { "operationId": "edit_inboxes", "summary": "Edit Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/inboxes/{id}": { "get": { "operationId": "show_inboxes", "summary": "Get Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "identifier": { "type": "string" }, "identity_validation_enabled": { "type": "string" }, "name": { "type": "string" }, "timezone": { "type": "string" }, "working_hours": { "type": "string" }, "working_hours_enabled": { "type": "boolean" }, "csat_survey_enabled": { "type": "boolean" }, "greeting_enabled": { "type": "boolean" }, "enable_multi_conversation": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_inboxes", "summary": "Update Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_inboxes", "summary": "Update Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "destroy_inboxes", "summary": "Delete Inboxes", "tags": [ "Public::Inboxes" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/public/api/v1/csat_survey/{id}": { "get": { "operationId": "show_csat_survey", "summary": "Get Csat Survey", "tags": [ "Public::Csat Survey" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "csat_survey_response": { "type": "string" }, "inbox_avatar_url": { "type": "string" }, "inbox_name": { "type": "string" }, "locale": { "type": "string" }, "conversation_id": { "type": "string" }, "created_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "update_csat_survey", "summary": "Update Csat Survey", "tags": [ "Public::Csat Survey" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "csat_survey_response": { "type": "string" }, "inbox_avatar_url": { "type": "string" }, "inbox_name": { "type": "string" }, "locale": { "type": "string" }, "conversation_id": { "type": "string" }, "created_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "update_csat_survey", "summary": "Update Csat Survey", "tags": [ "Public::Csat Survey" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "csat_survey_response": { "type": "string" }, "inbox_avatar_url": { "type": "string" }, "inbox_name": { "type": "string" }, "locale": { "type": "string" }, "conversation_id": { "type": "string" }, "created_at": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } } }, "components": { "securitySchemes": { "userApiKey": { "type": "apiKey", "in": "header", "name": "api_access_token", "description": "User API access token. Obtain from profile page or via API." }, "agentBotApiKey": { "type": "apiKey", "in": "header", "name": "api_access_token", "description": "Agent bot API key for bot integrations." }, "platformAppApiKey": { "type": "apiKey", "in": "header", "name": "api_access_token", "description": "Platform app API key for provisioning accounts, users and agent bots." } } } }