Skip to main content
PATCH
Update CSAT settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
web_enabled
boolean

Whether CSAT collection is enabled for web channel

email_enabled
boolean

Whether CSAT collection is enabled for email channel

phone_enabled
boolean

Whether CSAT collection is enabled for phone channel

whatsapp_enabled
boolean

Whether CSAT collection is enabled for WhatsApp channel

sms_enabled
boolean

Whether CSAT collection is enabled for SMS channel

slack_enabled
boolean

Whether CSAT collection is enabled for Slack channel

api_enabled
boolean

Whether CSAT collection is enabled for API channel

web_voice_enabled
boolean

Whether CSAT collection is enabled for web voice channel

instagram_enabled
boolean

Whether CSAT collection is enabled for Instagram channel

messenger_enabled
boolean

Whether CSAT collection is enabled for Facebook Messenger channel

custom_message
string

Custom message to display with CSAT request

auto_send_on_close
boolean

Whether to automatically send CSAT after session closes

send_delay_minutes
number

Delay in minutes before sending CSAT after session closes

web_template_html
string | null

Full-HTML template for the public CSAT feedback page. Null/empty clears it (default page).

email_template_html
string | null

Full-HTML template for the CSAT request email. Null/empty clears it (default email).

email_template_subject
string | null

Subject line for the custom CSAT request email. Null falls back to the default.

Response

Default Response

organization_id
string
required

The ID of the organization

web_enabled
boolean
required

Whether CSAT collection is enabled for web channel

email_enabled
boolean
required

Whether CSAT collection is enabled for email channel

phone_enabled
boolean
required

Whether CSAT collection is enabled for phone channel

whatsapp_enabled
boolean
required

Whether CSAT collection is enabled for WhatsApp channel

sms_enabled
boolean
required

Whether CSAT collection is enabled for SMS channel

slack_enabled
boolean
required

Whether CSAT collection is enabled for Slack channel

api_enabled
boolean
required

Whether CSAT collection is enabled for API channel

web_voice_enabled
boolean
required

Whether CSAT collection is enabled for web voice channel

instagram_enabled
boolean
required

Whether CSAT collection is enabled for Instagram channel

messenger_enabled
boolean
required

Whether CSAT collection is enabled for Facebook Messenger channel

custom_message
string | null
required

Custom message to display with CSAT request

auto_send_on_close
boolean
required

Whether to automatically send CSAT after session closes

send_delay_minutes
number
required

Delay in minutes before sending CSAT after session closes

web_template_html
string | null
required

Full-HTML template for the public CSAT feedback page (null = default page)

email_template_html
string | null
required

Full-HTML template for the CSAT request email (null = default email)

email_template_subject
string | null
required

Subject line for the custom CSAT request email (null = default subject)

created_at
string<date-time>
required

When the settings were created

updated_at
string<date-time>
required

When the settings were last updated