Update CSAT settings

curl --request PATCH \
  --url https://api.open.cx/csat/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "web_enabled": true,
  "email_enabled": true,
  "phone_enabled": true,
  "whatsapp_enabled": true,
  "sms_enabled": true,
  "slack_enabled": true,
  "api_enabled": true,
  "web_voice_enabled": true,
  "instagram_enabled": true,
  "messenger_enabled": true,
  "custom_message": "<string>",
  "auto_send_on_close": true,
  "send_delay_minutes": 123,
  "resend_after_days": 4503599627370496,
  "rescore_window_hours": 4503599627370495,
  "channel_config": {},
  "web_template_html": "<string>",
  "email_template_html": "<string>",
  "email_template_subject": "<string>"
}
'

import requests

url = "https://api.open.cx/csat/settings"

payload = {
    "web_enabled": True,
    "email_enabled": True,
    "phone_enabled": True,
    "whatsapp_enabled": True,
    "sms_enabled": True,
    "slack_enabled": True,
    "api_enabled": True,
    "web_voice_enabled": True,
    "instagram_enabled": True,
    "messenger_enabled": True,
    "custom_message": "<string>",
    "auto_send_on_close": True,
    "send_delay_minutes": 123,
    "resend_after_days": 4503599627370496,
    "rescore_window_hours": 4503599627370495,
    "channel_config": {},
    "web_template_html": "<string>",
    "email_template_html": "<string>",
    "email_template_subject": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    web_enabled: true,
    email_enabled: true,
    phone_enabled: true,
    whatsapp_enabled: true,
    sms_enabled: true,
    slack_enabled: true,
    api_enabled: true,
    web_voice_enabled: true,
    instagram_enabled: true,
    messenger_enabled: true,
    custom_message: '<string>',
    auto_send_on_close: true,
    send_delay_minutes: 123,
    resend_after_days: 4503599627370496,
    rescore_window_hours: 4503599627370495,
    channel_config: {},
    web_template_html: '<string>',
    email_template_html: '<string>',
    email_template_subject: '<string>'
  })
};

fetch('https://api.open.cx/csat/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.open.cx/csat/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'web_enabled' => true,
    'email_enabled' => true,
    'phone_enabled' => true,
    'whatsapp_enabled' => true,
    'sms_enabled' => true,
    'slack_enabled' => true,
    'api_enabled' => true,
    'web_voice_enabled' => true,
    'instagram_enabled' => true,
    'messenger_enabled' => true,
    'custom_message' => '<string>',
    'auto_send_on_close' => true,
    'send_delay_minutes' => 123,
    'resend_after_days' => 4503599627370496,
    'rescore_window_hours' => 4503599627370495,
    'channel_config' => [
        
    ],
    'web_template_html' => '<string>',
    'email_template_html' => '<string>',
    'email_template_subject' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.open.cx/csat/settings"

	payload := strings.NewReader("{\n  \"web_enabled\": true,\n  \"email_enabled\": true,\n  \"phone_enabled\": true,\n  \"whatsapp_enabled\": true,\n  \"sms_enabled\": true,\n  \"slack_enabled\": true,\n  \"api_enabled\": true,\n  \"web_voice_enabled\": true,\n  \"instagram_enabled\": true,\n  \"messenger_enabled\": true,\n  \"custom_message\": \"<string>\",\n  \"auto_send_on_close\": true,\n  \"send_delay_minutes\": 123,\n  \"resend_after_days\": 4503599627370496,\n  \"rescore_window_hours\": 4503599627370495,\n  \"channel_config\": {},\n  \"web_template_html\": \"<string>\",\n  \"email_template_html\": \"<string>\",\n  \"email_template_subject\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.open.cx/csat/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"web_enabled\": true,\n  \"email_enabled\": true,\n  \"phone_enabled\": true,\n  \"whatsapp_enabled\": true,\n  \"sms_enabled\": true,\n  \"slack_enabled\": true,\n  \"api_enabled\": true,\n  \"web_voice_enabled\": true,\n  \"instagram_enabled\": true,\n  \"messenger_enabled\": true,\n  \"custom_message\": \"<string>\",\n  \"auto_send_on_close\": true,\n  \"send_delay_minutes\": 123,\n  \"resend_after_days\": 4503599627370496,\n  \"rescore_window_hours\": 4503599627370495,\n  \"channel_config\": {},\n  \"web_template_html\": \"<string>\",\n  \"email_template_html\": \"<string>\",\n  \"email_template_subject\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.open.cx/csat/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"web_enabled\": true,\n  \"email_enabled\": true,\n  \"phone_enabled\": true,\n  \"whatsapp_enabled\": true,\n  \"sms_enabled\": true,\n  \"slack_enabled\": true,\n  \"api_enabled\": true,\n  \"web_voice_enabled\": true,\n  \"instagram_enabled\": true,\n  \"messenger_enabled\": true,\n  \"custom_message\": \"<string>\",\n  \"auto_send_on_close\": true,\n  \"send_delay_minutes\": 123,\n  \"resend_after_days\": 4503599627370496,\n  \"rescore_window_hours\": 4503599627370495,\n  \"channel_config\": {},\n  \"web_template_html\": \"<string>\",\n  \"email_template_html\": \"<string>\",\n  \"email_template_subject\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "organization_id": "<string>",
  "web_enabled": true,
  "email_enabled": true,
  "phone_enabled": true,
  "whatsapp_enabled": true,
  "sms_enabled": true,
  "slack_enabled": true,
  "api_enabled": true,
  "web_voice_enabled": true,
  "instagram_enabled": true,
  "messenger_enabled": true,
  "custom_message": "<string>",
  "auto_send_on_close": true,
  "send_delay_minutes": 123,
  "resend_after_days": 0,
  "rescore_window_hours": 4503599627370495,
  "channel_config": {},
  "web_template_html": "<string>",
  "email_template_html": "<string>",
  "email_template_subject": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

PATCH

csat

settings

Update CSAT settings

curl --request PATCH \
  --url https://api.open.cx/csat/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "web_enabled": true,
  "email_enabled": true,
  "phone_enabled": true,
  "whatsapp_enabled": true,
  "sms_enabled": true,
  "slack_enabled": true,
  "api_enabled": true,
  "web_voice_enabled": true,
  "instagram_enabled": true,
  "messenger_enabled": true,
  "custom_message": "<string>",
  "auto_send_on_close": true,
  "send_delay_minutes": 123,
  "resend_after_days": 4503599627370496,
  "rescore_window_hours": 4503599627370495,
  "channel_config": {},
  "web_template_html": "<string>",
  "email_template_html": "<string>",
  "email_template_subject": "<string>"
}
'

import requests

url = "https://api.open.cx/csat/settings"

payload = {
    "web_enabled": True,
    "email_enabled": True,
    "phone_enabled": True,
    "whatsapp_enabled": True,
    "sms_enabled": True,
    "slack_enabled": True,
    "api_enabled": True,
    "web_voice_enabled": True,
    "instagram_enabled": True,
    "messenger_enabled": True,
    "custom_message": "<string>",
    "auto_send_on_close": True,
    "send_delay_minutes": 123,
    "resend_after_days": 4503599627370496,
    "rescore_window_hours": 4503599627370495,
    "channel_config": {},
    "web_template_html": "<string>",
    "email_template_html": "<string>",
    "email_template_subject": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    web_enabled: true,
    email_enabled: true,
    phone_enabled: true,
    whatsapp_enabled: true,
    sms_enabled: true,
    slack_enabled: true,
    api_enabled: true,
    web_voice_enabled: true,
    instagram_enabled: true,
    messenger_enabled: true,
    custom_message: '<string>',
    auto_send_on_close: true,
    send_delay_minutes: 123,
    resend_after_days: 4503599627370496,
    rescore_window_hours: 4503599627370495,
    channel_config: {},
    web_template_html: '<string>',
    email_template_html: '<string>',
    email_template_subject: '<string>'
  })
};

fetch('https://api.open.cx/csat/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.open.cx/csat/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'web_enabled' => true,
    'email_enabled' => true,
    'phone_enabled' => true,
    'whatsapp_enabled' => true,
    'sms_enabled' => true,
    'slack_enabled' => true,
    'api_enabled' => true,
    'web_voice_enabled' => true,
    'instagram_enabled' => true,
    'messenger_enabled' => true,
    'custom_message' => '<string>',
    'auto_send_on_close' => true,
    'send_delay_minutes' => 123,
    'resend_after_days' => 4503599627370496,
    'rescore_window_hours' => 4503599627370495,
    'channel_config' => [
        
    ],
    'web_template_html' => '<string>',
    'email_template_html' => '<string>',
    'email_template_subject' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.open.cx/csat/settings"

	payload := strings.NewReader("{\n  \"web_enabled\": true,\n  \"email_enabled\": true,\n  \"phone_enabled\": true,\n  \"whatsapp_enabled\": true,\n  \"sms_enabled\": true,\n  \"slack_enabled\": true,\n  \"api_enabled\": true,\n  \"web_voice_enabled\": true,\n  \"instagram_enabled\": true,\n  \"messenger_enabled\": true,\n  \"custom_message\": \"<string>\",\n  \"auto_send_on_close\": true,\n  \"send_delay_minutes\": 123,\n  \"resend_after_days\": 4503599627370496,\n  \"rescore_window_hours\": 4503599627370495,\n  \"channel_config\": {},\n  \"web_template_html\": \"<string>\",\n  \"email_template_html\": \"<string>\",\n  \"email_template_subject\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.open.cx/csat/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"web_enabled\": true,\n  \"email_enabled\": true,\n  \"phone_enabled\": true,\n  \"whatsapp_enabled\": true,\n  \"sms_enabled\": true,\n  \"slack_enabled\": true,\n  \"api_enabled\": true,\n  \"web_voice_enabled\": true,\n  \"instagram_enabled\": true,\n  \"messenger_enabled\": true,\n  \"custom_message\": \"<string>\",\n  \"auto_send_on_close\": true,\n  \"send_delay_minutes\": 123,\n  \"resend_after_days\": 4503599627370496,\n  \"rescore_window_hours\": 4503599627370495,\n  \"channel_config\": {},\n  \"web_template_html\": \"<string>\",\n  \"email_template_html\": \"<string>\",\n  \"email_template_subject\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.open.cx/csat/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"web_enabled\": true,\n  \"email_enabled\": true,\n  \"phone_enabled\": true,\n  \"whatsapp_enabled\": true,\n  \"sms_enabled\": true,\n  \"slack_enabled\": true,\n  \"api_enabled\": true,\n  \"web_voice_enabled\": true,\n  \"instagram_enabled\": true,\n  \"messenger_enabled\": true,\n  \"custom_message\": \"<string>\",\n  \"auto_send_on_close\": true,\n  \"send_delay_minutes\": 123,\n  \"resend_after_days\": 4503599627370496,\n  \"rescore_window_hours\": 4503599627370495,\n  \"channel_config\": {},\n  \"web_template_html\": \"<string>\",\n  \"email_template_html\": \"<string>\",\n  \"email_template_subject\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "organization_id": "<string>",
  "web_enabled": true,
  "email_enabled": true,
  "phone_enabled": true,
  "whatsapp_enabled": true,
  "sms_enabled": true,
  "slack_enabled": true,
  "api_enabled": true,
  "web_voice_enabled": true,
  "instagram_enabled": true,
  "messenger_enabled": true,
  "custom_message": "<string>",
  "auto_send_on_close": true,
  "send_delay_minutes": 123,
  "resend_after_days": 0,
  "rescore_window_hours": 4503599627370495,
  "channel_config": {},
  "web_template_html": "<string>",
  "email_template_html": "<string>",
  "email_template_subject": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

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

resend_policy

enum<string>

How often the same session may be surveyed: once_per_session (default, one survey ever), once_per_close (one per closure, so a reopened session can be surveyed again), once_until_answered (re-ask after resend_after_days until the customer scores it), or always (survey every close, even one the customer already rated)

Available options:

always,

once_per_close,

once_per_session,

once_until_answered

resend_after_days

integer

Days to wait before re-asking an unanswered survey. Only used when resend_policy is once_until_answered

Required range: 1 <= x <= 9007199254740991

rescore_window_hours

integer | null

How long (hours, from the first submit) a customer may change their score. Null = unlimited re-rating, 0 = locked as soon as the first score lands. Staff submits are always exempt

Required range: 0 <= x <= 9007199254740991

channel_config

object

Per-channel overrides keyed by channel (e.g. { "whatsapp": { "rating_style": "emoji" } }). Replaces the whole map, so send the channels you want to keep

Show child attributes

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

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

Show child attributes

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

Overview

Blocklist

Autopilot

Organization

Contacts

Sessions

Connect

AI Phone Agents

AI Email

AI WhatsApp

AI Actions

AI Outbound Sequencing

Media

AI Training

Resource Usage

Customer Insights

Teams

CSAT

Redaction

Crawl

Tags

Office Hours

Handoff Analytics

SLA Analytics

Secrets

Workflows (Beta)

Salesforce MIAW

Webhooks

Update CSAT settings

Authorizations

Body

Response