Skip to main content
GET
Get CSAT settings

Authorizations

Authorization
string
header
required

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

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

resend_policy
enum<string>
required

How often the same session may be surveyed: once_per_session, once_per_close, once_until_answered, or always

Available options:
always,
once_per_close,
once_per_session,
once_until_answered
resend_after_days
integer
required

Days to wait before re-asking an unanswered survey (only used when resend_policy is once_until_answered)

Required range: -9007199254740991 <= x <= 9007199254740991
rescore_window_hours
integer | null
required

How long (hours, from the first submit) a customer may change their score (null = unlimited, 0 = locked immediately)

Required range: 0 <= x <= 9007199254740991
channel_config
object
required

Per-channel overrides keyed by channel; an absent channel inherits the org-wide settings

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