rodrigo/iachat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: add swagger spec for accounts API (#11620)

Browse Source
This commit is contained in:
Shivam Mishra 2025-05-29 11:23:27 +05:30 committed by GitHub
parent c3d98fc064
commit f6510e0d43
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 1360 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
swagger/definitions/index.yml
View File

@ -60,6 +60,10 @@ webhook:
$ref: ./resource/webhook.yml $ref: ./resource/webhook.yml
account: account:
$ref: ./resource/account.yml $ref: ./resource/account.yml
account_detail:
$ref: ./resource/account_detail.yml
account_show_response:
$ref: ./resource/account_show_response.yml
account_user: account_user:
$ref: ./resource/account_user.yml $ref: ./resource/account_user.yml
platform_account: platform_account:
@ -87,6 +91,9 @@ public_inbox:
account_create_update_payload: account_create_update_payload:
$ref: ./request/account/create_update_payload.yml $ref: ./request/account/create_update_payload.yml
account_update_payload:
$ref: ./request/account/update_payload.yml
account_user_create_update_payload: account_user_create_update_payload:
$ref: ./request/account_user/create_update_payload.yml $ref: ./request/account_user/create_update_payload.yml

49
swagger/definitions/request/account/update_payload.yml Normal file
View File

@ -0,0 +1,49 @@
type: object
properties:
name:
type: string
description: Name of the account
example: 'My Account'
locale:
type: string
description: The locale of the account
example: 'en'
domain:
type: string
description: The domain of the account
example: 'example.com'
support_email:
type: string
description: The support email of the account
example: 'support@example.com'
# Settings parameters (stored in settings JSONB column)
auto_resolve_after:
type: integer
minimum: 10
maximum: 1439856
nullable: true
description: Auto resolve conversations after specified minutes
example: 1440
auto_resolve_message:
type: string
nullable: true
description: Message to send when auto resolving
example: "This conversation has been automatically resolved due to inactivity"
auto_resolve_ignore_waiting:
type: boolean
nullable: true
description: Whether to ignore waiting conversations for auto resolve
example: false
# Custom attributes parameters (stored in custom_attributes JSONB column)
industry:
type: string
description: Industry type
example: "Technology"
company_size:
type: string
description: Company size
example: "50-100"
timezone:
type: string
description: Account timezone
example: "UTC"

84
swagger/definitions/resource/account_detail.yml Normal file
View File

@ -0,0 +1,84 @@
type: object
properties:
id:
type: number
description: Account ID
name:
type: string
description: Name of the account
locale:
type: string
description: The locale of the account
domain:
type: string
description: The domain of the account
support_email:
type: string
description: The support email of the account
status:
type: string
description: The status of the account
created_at:
type: string
format: date-time
description: The creation date of the account
cache_keys:
type: object
description: Cache keys for the account
features:
type: array
items:
type: string
description: Enabled features for the account
settings:
type: object
description: Account settings
properties:
auto_resolve_after:
type: number
description: Auto resolve conversations after specified minutes
auto_resolve_message:
type: string
description: Message to send when auto resolving
auto_resolve_ignore_waiting:
type: boolean
description: Whether to ignore waiting conversations for auto resolve
custom_attributes:
type: object
description: Custom attributes of the account
properties:
plan_name:
type: string
description: Subscription plan name
subscribed_quantity:
type: number
description: Subscribed quantity
subscription_status:
type: string
description: Subscription status
subscription_ends_on:
type: string
format: date
description: Subscription end date
industry:
type: string
description: Industry type
company_size:
type: string
description: Company size
timezone:
type: string
description: Account timezone
logo:
type: string
description: Account logo URL
onboarding_step:
type: string
description: Current onboarding step
marked_for_deletion_at:
type: string
format: date-time
description: When account was marked for deletion
marked_for_deletion_reason:
type: string
description: Reason for account deletion

13
swagger/definitions/resource/account_show_response.yml Normal file
View File

@ -0,0 +1,13 @@
allOf:
- $ref: '#/components/schemas/account_detail'
- type: object
properties:
latest_chatwoot_version:
type: string
description: Latest version of Chatwoot available
example: "3.0.0"
subscribed_features:
type: array
items:
type: string
description: List of subscribed enterprise features (if enterprise edition is enabled)

28
swagger/paths/application/accounts/show.yml Normal file
View File

@ -0,0 +1,28 @@
tags:
- Account
operationId: get-account-details
summary: Get account details
description: Get the details of the current account
security:
- userApiKey: []
parameters:
- $ref: '#/components/parameters/account_id'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/account_show_response'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'404':
description: Account not found
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

43
swagger/paths/application/accounts/update.yml Normal file
View File

@ -0,0 +1,43 @@
tags:
- Account
operationId: update-account
summary: Update account
description: Update account details, settings, and custom attributes
security:
- userApiKey: []
parameters:
- $ref: '#/components/parameters/account_id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/account_update_payload'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/account_update_payload'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/account_detail'
'401':
description: Unauthorized (requires administrator role)
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'404':
description: Account not found
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

9
swagger/paths/index.yml
View File

@ -166,6 +166,15 @@
# ------------ Application API routes ------------# # ------------ Application API routes ------------#
# Accounts
/api/v1/accounts/{id}:
parameters:
- $ref: '#/components/parameters/account_id'
get:
$ref: ./application/accounts/show.yml
patch:
$ref: ./application/accounts/update.yml
# AgentBots # AgentBots
/api/v1/accounts/{account_id}/agent_bots: /api/v1/accounts/{account_id}/agent_bots:
parameters: parameters:

331
swagger/swagger.json
View File

@ -1476,6 +1476,138 @@
} }
} }
}, },
"/api/v1/accounts/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/account_id"
}
],
"get": {
"tags": [
"Account"
],
"operationId": "get-account-details",
"summary": "Get account details",
"description": "Get the details of the current account",
"security": [
{
"userApiKey": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/account_id"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/account_show_response"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bad_request_error"
}
}
}
},
"404": {
"description": "Account not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bad_request_error"
}
}
}
}
}
},
"patch": {
"tags": [
"Account"
],
"operationId": "update-account",
"summary": "Update account",
"description": "Update account details, settings, and custom attributes",
"security": [
{
"userApiKey": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/account_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/account_update_payload"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/account_update_payload"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/account_detail"
}
}
}
},
"401": {
"description": "Unauthorized (requires administrator role)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bad_request_error"
}
}
}
},
"404": {
"description": "Account not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bad_request_error"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bad_request_error"
}
}
}
}
}
}
},
"/api/v1/accounts/{account_id}/agent_bots": { "/api/v1/accounts/{account_id}/agent_bots": {
"parameters": [ "parameters": [
{ {
@ -8774,6 +8906,145 @@
} }
} }
}, },
"account_detail": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Name of the account"
},
"locale": {
"type": "string",
"description": "The locale of the account"
},
"domain": {
"type": "string",
"description": "The domain of the account"
},
"support_email": {
"type": "string",
"description": "The support email of the account"
},
"status": {
"type": "string",
"description": "The status of the account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The creation date of the account"
},
"cache_keys": {
"type": "object",
"description": "Cache keys for the account"
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enabled features for the account"
},
"settings": {
"type": "object",
"description": "Account settings",
"properties": {
"auto_resolve_after": {
"type": "number",
"description": "Auto resolve conversations after specified minutes"
},
"auto_resolve_message": {
"type": "string",
"description": "Message to send when auto resolving"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"description": "Whether to ignore waiting conversations for auto resolve"
}
}
},
"custom_attributes": {
"type": "object",
"description": "Custom attributes of the account",
"properties": {
"plan_name": {
"type": "string",
"description": "Subscription plan name"
},
"subscribed_quantity": {
"type": "number",
"description": "Subscribed quantity"
},
"subscription_status": {
"type": "string",
"description": "Subscription status"
},
"subscription_ends_on": {
"type": "string",
"format": "date",
"description": "Subscription end date"
},
"industry": {
"type": "string",
"description": "Industry type"
},
"company_size": {
"type": "string",
"description": "Company size"
},
"timezone": {
"type": "string",
"description": "Account timezone"
},
"logo": {
"type": "string",
"description": "Account logo URL"
},
"onboarding_step": {
"type": "string",
"description": "Current onboarding step"
},
"marked_for_deletion_at": {
"type": "string",
"format": "date-time",
"description": "When account was marked for deletion"
},
"marked_for_deletion_reason": {
"type": "string",
"description": "Reason for account deletion"
}
}
}
}
},
"account_show_response": {
"allOf": [
{
"$ref": "#/components/schemas/account_detail"
},
{
"type": "object",
"properties": {
"latest_chatwoot_version": {
"type": "string",
"description": "Latest version of Chatwoot available",
"example": "3.0.0"
},
"subscribed_features": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of subscribed enterprise features (if enterprise edition is enabled)"
}
}
}
]
},
"account_user": { "account_user": {
"type": "array", "type": "array",
"description": "Array of account users", "description": "Array of account users",
@ -9113,6 +9384,66 @@
} }
} }
}, },
"account_update_payload": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the account",
"example": "My Account"
},
"locale": {
"type": "string",
"description": "The locale of the account",
"example": "en"
},
"domain": {
"type": "string",
"description": "The domain of the account",
"example": "example.com"
},
"support_email": {
"type": "string",
"description": "The support email of the account",
"example": "support@example.com"
},
"auto_resolve_after": {
"type": "integer",
"minimum": 10,
"maximum": 1439856,
"nullable": true,
"description": "Auto resolve conversations after specified minutes",
"example": 1440
},
"auto_resolve_message": {
"type": "string",
"nullable": true,
"description": "Message to send when auto resolving",
"example": "This conversation has been automatically resolved due to inactivity"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"nullable": true,
"description": "Whether to ignore waiting conversations for auto resolve",
"example": false
},
"industry": {
"type": "string",
"description": "Industry type",
"example": "Technology"
},
"company_size": {
"type": "string",
"description": "Company size",
"example": "50-100"
},
"timezone": {
"type": "string",
"description": "Account timezone",
"example": "UTC"
}
}
},
"account_user_create_update_payload": { "account_user_create_update_payload": {
"type": "object", "type": "object",
"required": [ "required": [

199
swagger/tag_groups/application_swagger.json
View File

@ -7135,6 +7135,145 @@
} }
} }
}, },
"account_detail": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Name of the account"
},
"locale": {
"type": "string",
"description": "The locale of the account"
},
"domain": {
"type": "string",
"description": "The domain of the account"
},
"support_email": {
"type": "string",
"description": "The support email of the account"
},
"status": {
"type": "string",
"description": "The status of the account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The creation date of the account"
},
"cache_keys": {
"type": "object",
"description": "Cache keys for the account"
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enabled features for the account"
},
"settings": {
"type": "object",
"description": "Account settings",
"properties": {
"auto_resolve_after": {
"type": "number",
"description": "Auto resolve conversations after specified minutes"
},
"auto_resolve_message": {
"type": "string",
"description": "Message to send when auto resolving"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"description": "Whether to ignore waiting conversations for auto resolve"
}
}
},
"custom_attributes": {
"type": "object",
"description": "Custom attributes of the account",
"properties": {
"plan_name": {
"type": "string",
"description": "Subscription plan name"
},
"subscribed_quantity": {
"type": "number",
"description": "Subscribed quantity"
},
"subscription_status": {
"type": "string",
"description": "Subscription status"
},
"subscription_ends_on": {
"type": "string",
"format": "date",
"description": "Subscription end date"
},
"industry": {
"type": "string",
"description": "Industry type"
},
"company_size": {
"type": "string",
"description": "Company size"
},
"timezone": {
"type": "string",
"description": "Account timezone"
},
"logo": {
"type": "string",
"description": "Account logo URL"
},
"onboarding_step": {
"type": "string",
"description": "Current onboarding step"
},
"marked_for_deletion_at": {
"type": "string",
"format": "date-time",
"description": "When account was marked for deletion"
},
"marked_for_deletion_reason": {
"type": "string",
"description": "Reason for account deletion"
}
}
}
}
},
"account_show_response": {
"allOf": [
{
"$ref": "#/components/schemas/account_detail"
},
{
"type": "object",
"properties": {
"latest_chatwoot_version": {
"type": "string",
"description": "Latest version of Chatwoot available",
"example": "3.0.0"
},
"subscribed_features": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of subscribed enterprise features (if enterprise edition is enabled)"
}
}
}
]
},
"account_user": { "account_user": {
"type": "array", "type": "array",
"description": "Array of account users", "description": "Array of account users",
@ -7474,6 +7613,66 @@
} }
} }
}, },
"account_update_payload": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the account",
"example": "My Account"
},
"locale": {
"type": "string",
"description": "The locale of the account",
"example": "en"
},
"domain": {
"type": "string",
"description": "The domain of the account",
"example": "example.com"
},
"support_email": {
"type": "string",
"description": "The support email of the account",
"example": "support@example.com"
},
"auto_resolve_after": {
"type": "integer",
"minimum": 10,
"maximum": 1439856,
"nullable": true,
"description": "Auto resolve conversations after specified minutes",
"example": 1440
},
"auto_resolve_message": {
"type": "string",
"nullable": true,
"description": "Message to send when auto resolving",
"example": "This conversation has been automatically resolved due to inactivity"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"nullable": true,
"description": "Whether to ignore waiting conversations for auto resolve",
"example": false
},
"industry": {
"type": "string",
"description": "Industry type",
"example": "Technology"
},
"company_size": {
"type": "string",
"description": "Company size",
"example": "50-100"
},
"timezone": {
"type": "string",
"description": "Account timezone",
"example": "UTC"
}
}
},
"account_user_create_update_payload": { "account_user_create_update_payload": {
"type": "object", "type": "object",
"required": [ "required": [

199
swagger/tag_groups/client_swagger.json
View File

@ -1978,6 +1978,145 @@
} }
} }
}, },
"account_detail": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Name of the account"
},
"locale": {
"type": "string",
"description": "The locale of the account"
},
"domain": {
"type": "string",
"description": "The domain of the account"
},
"support_email": {
"type": "string",
"description": "The support email of the account"
},
"status": {
"type": "string",
"description": "The status of the account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The creation date of the account"
},
"cache_keys": {
"type": "object",
"description": "Cache keys for the account"
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enabled features for the account"
},
"settings": {
"type": "object",
"description": "Account settings",
"properties": {
"auto_resolve_after": {
"type": "number",
"description": "Auto resolve conversations after specified minutes"
},
"auto_resolve_message": {
"type": "string",
"description": "Message to send when auto resolving"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"description": "Whether to ignore waiting conversations for auto resolve"
}
}
},
"custom_attributes": {
"type": "object",
"description": "Custom attributes of the account",
"properties": {
"plan_name": {
"type": "string",
"description": "Subscription plan name"
},
"subscribed_quantity": {
"type": "number",
"description": "Subscribed quantity"
},
"subscription_status": {
"type": "string",
"description": "Subscription status"
},
"subscription_ends_on": {
"type": "string",
"format": "date",
"description": "Subscription end date"
},
"industry": {
"type": "string",
"description": "Industry type"
},
"company_size": {
"type": "string",
"description": "Company size"
},
"timezone": {
"type": "string",
"description": "Account timezone"
},
"logo": {
"type": "string",
"description": "Account logo URL"
},
"onboarding_step": {
"type": "string",
"description": "Current onboarding step"
},
"marked_for_deletion_at": {
"type": "string",
"format": "date-time",
"description": "When account was marked for deletion"
},
"marked_for_deletion_reason": {
"type": "string",
"description": "Reason for account deletion"
}
}
}
}
},
"account_show_response": {
"allOf": [
{
"$ref": "#/components/schemas/account_detail"
},
{
"type": "object",
"properties": {
"latest_chatwoot_version": {
"type": "string",
"description": "Latest version of Chatwoot available",
"example": "3.0.0"
},
"subscribed_features": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of subscribed enterprise features (if enterprise edition is enabled)"
}
}
}
]
},
"account_user": { "account_user": {
"type": "array", "type": "array",
"description": "Array of account users", "description": "Array of account users",
@ -2317,6 +2456,66 @@
} }
} }
}, },
"account_update_payload": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the account",
"example": "My Account"
},
"locale": {
"type": "string",
"description": "The locale of the account",
"example": "en"
},
"domain": {
"type": "string",
"description": "The domain of the account",
"example": "example.com"
},
"support_email": {
"type": "string",
"description": "The support email of the account",
"example": "support@example.com"
},
"auto_resolve_after": {
"type": "integer",
"minimum": 10,
"maximum": 1439856,
"nullable": true,
"description": "Auto resolve conversations after specified minutes",
"example": 1440
},
"auto_resolve_message": {
"type": "string",
"nullable": true,
"description": "Message to send when auto resolving",
"example": "This conversation has been automatically resolved due to inactivity"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"nullable": true,
"description": "Whether to ignore waiting conversations for auto resolve",
"example": false
},
"industry": {
"type": "string",
"description": "Industry type",
"example": "Technology"
},
"company_size": {
"type": "string",
"description": "Company size",
"example": "50-100"
},
"timezone": {
"type": "string",
"description": "Account timezone",
"example": "UTC"
}
}
},
"account_user_create_update_payload": { "account_user_create_update_payload": {
"type": "object", "type": "object",
"required": [ "required": [

199
swagger/tag_groups/other_swagger.json
View File

@ -1393,6 +1393,145 @@
} }
} }
}, },
"account_detail": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Name of the account"
},
"locale": {
"type": "string",
"description": "The locale of the account"
},
"domain": {
"type": "string",
"description": "The domain of the account"
},
"support_email": {
"type": "string",
"description": "The support email of the account"
},
"status": {
"type": "string",
"description": "The status of the account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The creation date of the account"
},
"cache_keys": {
"type": "object",
"description": "Cache keys for the account"
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enabled features for the account"
},
"settings": {
"type": "object",
"description": "Account settings",
"properties": {
"auto_resolve_after": {
"type": "number",
"description": "Auto resolve conversations after specified minutes"
},
"auto_resolve_message": {
"type": "string",
"description": "Message to send when auto resolving"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"description": "Whether to ignore waiting conversations for auto resolve"
}
}
},
"custom_attributes": {
"type": "object",
"description": "Custom attributes of the account",
"properties": {
"plan_name": {
"type": "string",
"description": "Subscription plan name"
},
"subscribed_quantity": {
"type": "number",
"description": "Subscribed quantity"
},
"subscription_status": {
"type": "string",
"description": "Subscription status"
},
"subscription_ends_on": {
"type": "string",
"format": "date",
"description": "Subscription end date"
},
"industry": {
"type": "string",
"description": "Industry type"
},
"company_size": {
"type": "string",
"description": "Company size"
},
"timezone": {
"type": "string",
"description": "Account timezone"
},
"logo": {
"type": "string",
"description": "Account logo URL"
},
"onboarding_step": {
"type": "string",
"description": "Current onboarding step"
},
"marked_for_deletion_at": {
"type": "string",
"format": "date-time",
"description": "When account was marked for deletion"
},
"marked_for_deletion_reason": {
"type": "string",
"description": "Reason for account deletion"
}
}
}
}
},
"account_show_response": {
"allOf": [
{
"$ref": "#/components/schemas/account_detail"
},
{
"type": "object",
"properties": {
"latest_chatwoot_version": {
"type": "string",
"description": "Latest version of Chatwoot available",
"example": "3.0.0"
},
"subscribed_features": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of subscribed enterprise features (if enterprise edition is enabled)"
}
}
}
]
},
"account_user": { "account_user": {
"type": "array", "type": "array",
"description": "Array of account users", "description": "Array of account users",
@ -1732,6 +1871,66 @@
} }
} }
}, },
"account_update_payload": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the account",
"example": "My Account"
},
"locale": {
"type": "string",
"description": "The locale of the account",
"example": "en"
},
"domain": {
"type": "string",
"description": "The domain of the account",
"example": "example.com"
},
"support_email": {
"type": "string",
"description": "The support email of the account",
"example": "support@example.com"
},
"auto_resolve_after": {
"type": "integer",
"minimum": 10,
"maximum": 1439856,
"nullable": true,
"description": "Auto resolve conversations after specified minutes",
"example": 1440
},
"auto_resolve_message": {
"type": "string",
"nullable": true,
"description": "Message to send when auto resolving",
"example": "This conversation has been automatically resolved due to inactivity"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"nullable": true,
"description": "Whether to ignore waiting conversations for auto resolve",
"example": false
},
"industry": {
"type": "string",
"description": "Industry type",
"example": "Technology"
},
"company_size": {
"type": "string",
"description": "Company size",
"example": "50-100"
},
"timezone": {
"type": "string",
"description": "Account timezone",
"example": "UTC"
}
}
},
"account_user_create_update_payload": { "account_user_create_update_payload": {
"type": "object", "type": "object",
"required": [ "required": [

199
swagger/tag_groups/platform_swagger.json
View File

@ -2154,6 +2154,145 @@
} }
} }
}, },
"account_detail": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Name of the account"
},
"locale": {
"type": "string",
"description": "The locale of the account"
},
"domain": {
"type": "string",
"description": "The domain of the account"
},
"support_email": {
"type": "string",
"description": "The support email of the account"
},
"status": {
"type": "string",
"description": "The status of the account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The creation date of the account"
},
"cache_keys": {
"type": "object",
"description": "Cache keys for the account"
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enabled features for the account"
},
"settings": {
"type": "object",
"description": "Account settings",
"properties": {
"auto_resolve_after": {
"type": "number",
"description": "Auto resolve conversations after specified minutes"
},
"auto_resolve_message": {
"type": "string",
"description": "Message to send when auto resolving"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"description": "Whether to ignore waiting conversations for auto resolve"
}
}
},
"custom_attributes": {
"type": "object",
"description": "Custom attributes of the account",
"properties": {
"plan_name": {
"type": "string",
"description": "Subscription plan name"
},
"subscribed_quantity": {
"type": "number",
"description": "Subscribed quantity"
},
"subscription_status": {
"type": "string",
"description": "Subscription status"
},
"subscription_ends_on": {
"type": "string",
"format": "date",
"description": "Subscription end date"
},
"industry": {
"type": "string",
"description": "Industry type"
},
"company_size": {
"type": "string",
"description": "Company size"
},
"timezone": {
"type": "string",
"description": "Account timezone"
},
"logo": {
"type": "string",
"description": "Account logo URL"
},
"onboarding_step": {
"type": "string",
"description": "Current onboarding step"
},
"marked_for_deletion_at": {
"type": "string",
"format": "date-time",
"description": "When account was marked for deletion"
},
"marked_for_deletion_reason": {
"type": "string",
"description": "Reason for account deletion"
}
}
}
}
},
"account_show_response": {
"allOf": [
{
"$ref": "#/components/schemas/account_detail"
},
{
"type": "object",
"properties": {
"latest_chatwoot_version": {
"type": "string",
"description": "Latest version of Chatwoot available",
"example": "3.0.0"
},
"subscribed_features": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of subscribed enterprise features (if enterprise edition is enabled)"
}
}
}
]
},
"account_user": { "account_user": {
"type": "array", "type": "array",
"description": "Array of account users", "description": "Array of account users",
@ -2493,6 +2632,66 @@
} }
} }
}, },
"account_update_payload": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the account",
"example": "My Account"
},
"locale": {
"type": "string",
"description": "The locale of the account",
"example": "en"
},
"domain": {
"type": "string",
"description": "The domain of the account",
"example": "example.com"
},
"support_email": {
"type": "string",
"description": "The support email of the account",
"example": "support@example.com"
},
"auto_resolve_after": {
"type": "integer",
"minimum": 10,
"maximum": 1439856,
"nullable": true,
"description": "Auto resolve conversations after specified minutes",
"example": 1440
},
"auto_resolve_message": {
"type": "string",
"nullable": true,
"description": "Message to send when auto resolving",
"example": "This conversation has been automatically resolved due to inactivity"
},
"auto_resolve_ignore_waiting": {
"type": "boolean",
"nullable": true,
"description": "Whether to ignore waiting conversations for auto resolve",
"example": false
},
"industry": {
"type": "string",
"description": "Industry type",
"example": "Technology"
},
"company_size": {
"type": "string",
"description": "Company size",
"example": "50-100"
},
"timezone": {
"type": "string",
"description": "Account timezone",
"example": "UTC"
}
}
},
"account_user_create_update_payload": { "account_user_create_update_payload": {
"type": "object", "type": "object",
"required": [ "required": [