Sony MathewandGitHub
259187e1fd
## Description Adds Swagger API documentation for branded email layouts, including the account-level layout endpoint, Email inbox update field, and generated API schemas. This stacked PR keeps the implementation review in #14936 focused on the product change. Related: [CW-7514](https://linear.app/chatwoot/issue/CW-7514/branded-html-email-templates-per-inboxbrand) Depends on #14936 ## Type of change - [x] This change requires a documentation update ## How to test 1. Run `bundle exec rake swagger:build`. 2. Start Chatwoot locally and open `http://localhost:3000/swagger`. 3. Verify the branded email layout account endpoint and Email inbox `branded_email_layout` field appear in the API reference. ## Checklist - [x] I have performed a self-review of my changes - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings
130 lines
3.7 KiB
YAML
130 lines
3.7 KiB
YAML
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The name of the inbox.
|
|
example: 'Support'
|
|
avatar:
|
|
type: string
|
|
format: binary
|
|
description: Image file for avatar.
|
|
greeting_enabled:
|
|
type: boolean
|
|
description: Enable greeting message.
|
|
example: true
|
|
greeting_message:
|
|
type: string
|
|
description: Greeting message to send when greeting messages are enabled.
|
|
example: Hello, how can I help you?
|
|
enable_email_collect:
|
|
type: boolean
|
|
description: |
|
|
Enable email collection.
|
|
|
|
Available for: `Website`
|
|
example: true
|
|
csat_survey_enabled:
|
|
type: boolean
|
|
description: Enable CSAT survey.
|
|
example: true
|
|
csat_config:
|
|
type: object
|
|
description: CSAT survey configuration.
|
|
properties:
|
|
display_type:
|
|
type: string
|
|
description: Display style for the CSAT survey.
|
|
enum: ['emoji', 'star']
|
|
example: emoji
|
|
message:
|
|
type: string
|
|
description: Message shown with the CSAT survey.
|
|
example: Please rate your conversation
|
|
button_text:
|
|
type: string
|
|
description: Text shown on the CSAT survey button.
|
|
example: Please rate us
|
|
language:
|
|
type: string
|
|
description: Language code for the CSAT survey.
|
|
example: en
|
|
survey_rules:
|
|
type: object
|
|
description: Rules that decide when to show the CSAT survey.
|
|
properties:
|
|
operator:
|
|
type: string
|
|
example: contains
|
|
values:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: ['billing']
|
|
enable_auto_assignment:
|
|
type: boolean
|
|
description: Enable Auto Assignment.
|
|
example: true
|
|
working_hours_enabled:
|
|
type: boolean
|
|
description: Enable working hours.
|
|
example: true
|
|
out_of_office_message:
|
|
type: string
|
|
description: Out of office message to send outside working hours.
|
|
example: We are currently out of office. Please leave a message and we will get back to you.
|
|
timezone:
|
|
type: string
|
|
description: Timezone of the inbox.
|
|
example: 'America/New_York'
|
|
allow_messages_after_resolved:
|
|
type: boolean
|
|
description: |
|
|
Allow messages after conversation is resolved.
|
|
|
|
Available for: `Website`
|
|
example: true
|
|
lock_to_single_conversation:
|
|
type: boolean
|
|
description: |
|
|
Lock contact messages to a single active conversation.
|
|
|
|
Available for: `API` `LINE` `Telegram` `WhatsApp` `SMS`
|
|
example: true
|
|
portal_id:
|
|
type: integer
|
|
description: Id of the help center portal to attach to the inbox.
|
|
example: 1
|
|
sender_name_type:
|
|
type: string
|
|
description: |
|
|
Sender name type for outbound email replies.
|
|
|
|
Available for: `Website` `Email`
|
|
enum: ['friendly', 'professional']
|
|
example: 'friendly'
|
|
business_name:
|
|
type: string
|
|
description: |
|
|
Business name for outbound email replies.
|
|
|
|
Available for: `Website` `Email`
|
|
example: 'My Business'
|
|
branded_email_layout:
|
|
type:
|
|
- string
|
|
- 'null'
|
|
description: |
|
|
Liquid HTML layout for outbound email replies. Must include `{{ content_for_layout }}`.
|
|
|
|
Available for: `Email`
|
|
example: '<html><body>{{ content_for_layout }}</body></html>'
|
|
channel:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/inbox_update_web_widget_channel_payload'
|
|
- $ref: '#/components/schemas/inbox_update_api_channel_payload'
|
|
- $ref: '#/components/schemas/inbox_update_email_channel_payload'
|
|
- $ref: '#/components/schemas/inbox_update_line_channel_payload'
|
|
- $ref: '#/components/schemas/inbox_update_telegram_channel_payload'
|
|
- $ref: '#/components/schemas/inbox_update_whatsapp_channel_payload'
|
|
- $ref: '#/components/schemas/inbox_update_sms_channel_payload'
|