Account settings are settings specific to your Zendesk account which affect how your account behaves. Some settings are read-only, but others can be updated through the API.

JSON format

Account Settings are represented as JSON objects with the following properties:

NameTypeRead-onlyMandatoryDescription
active_featuresobjectfalsefalseThe active features for an account. See Active Features
agentsobjectfalsefalseConfiguration for the agent workspace. See Agents
apiobjectfalsefalseAPI configuration options. See API
appsobjectfalsefalseApps configuration options. See Apps
billingobjectfalsefalseBilling configuration options. See Billing
brandingobjectfalsefalseBranding settings. See Branding
brandsobjectfalsefalseBrand settings. See Brands
cdnobjectfalsefalseCDN settings
chatobjectfalsefalseZendesk Chat settings. See Chat
cross_sellobjectfalsefalseCross Sell settings
gooddata_advanced_analyticsobjectfalsefalseGoodData settings, used for insights. Legacy configuration prior to Zendesk Explore. See GoodData Advanced Analytics
google_appsobjectfalsefalseGoogle Apps configuration. See G Suite
groupsobjectfalsefalseGroup configuration
limitsobjectfalsefalseAccount limits configuration. See Limits
localizationobjectfalsefalseInternationalization configuration settings. See Localization
lotusobjectfalsefalseSupport UI settings. See Lotus
metricsobjectfalsefalseAccount metrics settings. See Metrics
onboardingobjectfalsefalseOnboarding settings
routingobjectfalsefalseConfiguration for routing. See Routing
ruleobjectfalsefalseRules settings for triggers, macros, views, and automations. See Rules
side_conversationsobjectfalsefalseSide conversations settings
statisticsobjectfalsefalseAccount statistics settings. See Statistics
ticket_formobjectfalsefalseTicket form settings. See Ticket Form
ticketsobjectfalsefalseTicket settings. See Tickets
twitterobjectfalsefalseX (formerly Twitter) settings. See X
userobjectfalsefalseUser settings. See Users
voiceobjectfalsefalseZendesk Talk settings. See Voice

You can access the following data describing the settings of an account. You can update the settings marked as not read-only.

Branding

NameTypeRead-onlyComment
header_colorstringnoHEX of the header color
page_background_colorstringnoHEX of the page background color
tab_background_colorstringnoHEX of tab background color
text_colorstringnoHEX of the text color, usually matched to contrast well with header_color
header_logo_urlstringyesThe URL for the custom header logo
favicon_urlstringyesThe URL for the custom favicon

Apps

NameTypeRead-onlyComment
usebooleanyesThe account can use apps
create_privatebooleanyesThe account can create private apps

Tickets

NameTypeRead-onlyComment
comments_public_by_defaultbooleannoComments from agents are public by default
is_first_comment_private_enabledbooleannoAllow first comment on tickets to be private
list_newest_comments_firstbooleannoWhen viewing a ticket, show the newest comments and events first
collaborationbooleanyesCCs may be added to a ticket
private_attachmentsbooleannoUsers must sign in to access attachments
email_attachmentsbooleannoAttachments should be sent as real attachments when under the size limit
agent_collisionbooleanyesClients should provide an indicator when a ticket is being viewed by ther agent
list_empty_viewsbooleannoClients should display views with no matching tickets in menus
maximum_personal_views_to_listnumberyesMaximum number of personal views clients should display in menus
taggingbooleannoTickets may be tagged
markdown_ticket_commentsbooleannoWhether agent comments should be processed with Markdown
emoji_autocompletionbooleannoWhether agent comments should allow for Emoji rendering
agent_ticket_deletionbooleannoWhether agents can delete tickets
assign_default_organizationbooleanyesWhether a ticket is assigned to the requester's default organization in multi-organization mode
agent_invitation_enabledbooleannoWhether agent invitation should be allowed for tickets
chat_sla_enablementbooleannoWhether the proper SLA behavior should be applied to chat tickets
modern_ticket_reassignmentbooleannoIf True, turns on modern ticket reassignment for solved tickets
show_modern_ticket_reassignmentbooleannoIf True, shows UI components for modern ticket reassignment for solved tickets
default_solved_ticket_reassignment_strategystringnoDefault solved ticket reassignment strategy

Agents

NameTypeRead-onlyComment
agent_workspacebooleannoToggles the Agent Workspace experience
aw_self_serve_migration_enabledbooleanyesToggles the AW Self-serve migration control setting

Chat

NameTypeRead-onlyComment
enabledbooleanyesChat is enabled
maximum_requestsnumberyesThe maximum number of chat requests an agent may handle at one time
welcome_messagestringyesThe message automatically sent to end-users when they begin chatting with agent

X (formerly Twitter)

NameTypeRead-onlyComment
shorten_urlstringyesPossible values: 'always', 'optional', 'never'

G Suite

NameTypeRead-onlyComment
has_google_appsbooleanyes
has_google_apps_adminbooleannoAccount has at least one G Suite admin

Voice

NameTypeRead-onlyComment
enabledbooleanyesVoice is enabled
maintenancebooleanyes
loggingbooleanyes
outbound_enabledbooleanyes
agent_confirmation_when_forwardingbooleanyes
agent_wrap_up_after_callsbooleanyes
maximum_queue_sizenumberyes
maximum_queue_wait_timenumberyes
only_during_business_hoursbooleanyes
recordings_publicbooleanyes
uk_mobile_forwardingbooleanyes

Users

NameTypeRead-onlyComment
taggingbooleannoUsers may be tagged
time_zone_selectionbooleanyesWhether user can view time zone for profile
language_selectionbooleanyesWhether to display language drop down for a user
agent_created_welcome_emailsbooleannoWhether a user created by an agent receives a welcome email
end_user_phone_number_validationbooleannoWhether a user's phone number is validated
have_gravatars_enabledbooleannoWhether user gravatars are displayed in the UI

GoodData Advanced Analytics

NameTypeRead-onlyComment
enabledbooleanyesGoodData Advanced Analytics is enabled

Brands

NameTypeRead-onlyComment
default_brand_idnumbernoThe id of the brand that is assigned to tickets by default
require_brand_on_new_ticketsbooleannoRequire agents to select a brand before saving tickets

Statistics

NameTypeRead-onlyComment
forumbooleanyesAllow users to view forum statistics
searchbooleanyesAllow users to view search statistics

Billing

NameTypeRead-onlyComment
backendstringyesBackend Billing system either 'internal' or 'zuora'

Active Features

NameTypeRead-onlyComment
on_hold_statusbooleanyesAccount can use status hold
user_taggingbooleannoEnable user tags
ticket_taggingbooleannoAllow tagging tickets
topic_suggestionbooleanyesAllow topic suggestions in tickets
voicebooleanyesVoice support
facebook_loginbooleanyes
google_loginbooleanyes
twitter_loginbooleanyes
forum_analyticsbooleanyesForum and search analytics
business_hoursbooleanno
agent_forwardingbooleanyes
chatbooleanyes
chat_about_my_ticketbooleanyes
customer_satisfactionbooleanno
satisfaction_predictionbooleanno
csat_reason_codebooleanyes
markdownbooleanyesMarkdown in ticket comments
bcc_archivingbooleanyesAccount has a bcc_archive_address set
allow_ccsbooleanyesAllow CCs on tickets
advanced_analyticsbooleanyes
insightsbooleanyes
explorebooleanyesHas account plan setting 'explore'
good_data_and_explorebooleanyesHas account plan setting 'good_data_and_explore'
explore_on_support_pro_planbooleanyesAllowed to show explore role controls
sandboxbooleanyesAccount has a sandbox
suspended_ticket_notificationbooleanyes
twitterbooleanyesAccount monitors at least one X (formerly Twitter) handle
facebookbooleanyesAccount is actively linked to at least one Facebook page
feedback_tabsbooleanyesFeedback tab has been configured before
dynamic_contentsbooleanyesAccount has at least one dynamic content
light_agentsbooleanyesAccount has at least one light agent
is_abusivebooleanyesAccount exceeded trial limits
rich_content_in_emailbooleanyesAccount supports incoming HTML email
fallback_composerbooleanyesFallback composer for Asian languages
custom_objects_activatedbooleannoAccount has custom objects feature activated
organization_access_enabledbooleannoDisplays the Organizations page

API

NameTypeRead-onlyComment
accepted_api_agreementbooleannoAccount has accepted the API agreement
api_password_accessbooleannoAllow the account to use the API with username/password
api_token_accessbooleannoAllow the account to use the API with API tokens

Ticket Form

NameTypeRead-onlyComment
ticket_forms_instructionsstringno

Lotus

NameTypeRead-onlyComment
prefer_lotusbooleanyesPrefers the current version of Zendesk Support rather than Zendesk Classic

Rules

NameTypeRead-onlyComment
macro_most_usedbooleannoDisplay the most-used macros in the Apply macro list. Defaults to true
macro_orderstringnoDefault macro display order. Possible values are 'alphabetical' or 'position'
skill_based_filtered_viewsobjectnoArray of view ids

Limits

NameTypeRead-onlyComment
attachment_sizenumberyesThe maximum ticket attachment file size (in bytes)

Metrics

NameTypeRead-onlyComment
account_sizestringyesAn account size category computed from the number of billable agents

Localization

NameTypeRead-onlyComment
locale_idsarraynoArray of locale IDs enabled for the account. See Locales for possible values
time_zonestringnoThe time zone for the account
iana_time_zonestringyesThe IANA (Internet Assigned Numbers Authority) time zone designation for the account
default_locale_identifierstringnoThe default locale for the account
uses_12_hour_clockbooleannoToggles what time format is used for the account

Routing

NameTypeRead-onlyComment
enabledbooleannoToggles auto-routing functionality
autorouting_tagstringnoItems tagged with this value will be auto-routed
max_email_capacitynumbernoMax number of email tickets that can be auto-assigned
max_messaging_capacitynumbernoMax number of messaging tickets that can be auto-assigned
reassignment_messaging_enabledbooleannoWhether the account is enabled with reassignment in messaging channel
reassignment_messaging_timeoutnumbernoThe amount of time before the chat is assigned to another agent
reassignment_talk_timeoutnumbernoThe amount of time before the call is assigned to another agent

Example

{  "active_features": {    "advanced_analytics": false,    "agent_forwarding": false,    "allow_ccs": true,    "allow_email_template_customization": true,    "automatic_answers": false,    "bcc_archiving": false,    "benchmark_opt_out": false,    "business_hours": false,    "chat": false,    "chat_about_my_ticket": false,    "csat_reason_code": false,    "custom_dkim_domain": true,    "customer_context_as_default": false,    "customer_satisfaction": false,    "dynamic_contents": false,    "explore": true,    "explore_on_support_ent_plan": false,    "explore_on_support_pro_plan": false,    "facebook": false,    "facebook_login": false,    "fallback_composer": false,    "forum_analytics": true,    "good_data_and_explore": false,    "google_login": false,    "insights": false,    "is_abusive": false,    "light_agents": false,    "markdown": false,    "on_hold_status": false,    "organization_access_enabled": true,    "rich_content_in_emails": true,    "sandbox": false,    "satisfaction_prediction": false,    "suspended_ticket_notification": false,    "ticket_forms": true,    "ticket_tagging": true,    "topic_suggestion": false,    "twitter": true,    "twitter_login": false,    "user_org_fields": true,    "user_tagging": true,    "voice": true  },  "agents": {    "agent_home": false,    "agent_workspace": false,    "aw_self_serve_migration_enabled": true,    "focus_mode": false,    "idle_timeout_enabled": false,    "unified_agent_statuses": false  },  "api": {    "accepted_api_agreement": true,    "api_password_access": "true",    "api_token_access": "true"  },  "apps": {    "create_private": true,    "create_public": false,    "use": true  },  "billing": {    "backend": "zuora"  },  "branding": {    "favicon_url": null,    "header_color": "78A300",    "header_logo_url": null,    "page_background_color": "333333",    "tab_background_color": "7FA239",    "text_color": "FFFFFF"  },  "brands": {    "default_brand_id": 1873,    "require_brand_on_new_tickets": false  },  "cdn": {    "cdn_provider": "default",    "fallback_cdn_provider": "cloudfront",    "hosts": [      {        "name": "default",        "url": "https://p18.zdassets.com"      },      {        "name": "cloudfront",        "url": "https://d2y9oszrd3dhjh.cloudfront.net"      }    ]  },  "chat": {    "available": true,    "enabled": false,    "integrated": true,    "maximum_request_count": 1,    "welcome_message": "Hi there. How can I help today?"  },  "cross_sell": {    "show_chat_tooltip": true,    "xsell_source": null  },  "gooddata_advanced_analytics": {    "enabled": true  },  "google_apps": {    "has_google_apps": false,    "has_google_apps_admin": false  },  "groups": {    "check_group_name_uniqueness": true  },  "limits": {    "attachment_size": 52428800  },  "localization": {    "locale_ids": [      1042    ]  },  "lotus": {    "pod_id": 999,    "prefer_lotus": true,    "reporting": true  },  "metrics": {    "account_size": "100-399"  },  "onboarding": {    "checklist_onboarding_version": 2,    "onboarding_segments": null,    "product_sign_up": null  },  "routing": {    "autorouting_tag": "",    "enabled": false,    "max_email_capacity": 0,    "max_messaging_capacity": 0,    "reassignment_messaging_enabled": true,    "reassignment_messaging_timeout": 30,    "reassignment_talk_timeout": 30  },  "rule": {    "macro_most_used": true,    "macro_order": "alphabetical",    "skill_based_filtered_views": [],    "using_skill_based_routing": false  },  "side_conversations": {    "email_channel": false,    "msteams_channel": false,    "show_in_context_panel": false,    "slack_channel": false,    "tickets_channel": false  },  "statistics": {    "forum": true,    "rule_usage": true,    "search": true  },  "ticket_form": {    "raw_ticket_forms_instructions": "Please choose your issue below",    "ticket_forms_instructions": "Please choose your issue below"  },  "tickets": {    "accepted_new_collaboration_tos": false,    "agent_collision": true,    "agent_invitation_enabled": true,    "agent_ticket_deletion": false,    "allow_group_reset": true,    "assign_default_organization": true,    "assign_tickets_upon_solve": true,    "auto_translation_enabled": false,    "auto_updated_ccs_followers_rules": false,    "chat_sla_enablement": false,    "collaboration": true,    "comments_public_by_default": true,    "default_solved_ticket_reassignment_strategy": "legacy",    "email_attachments": false,    "emoji_autocompletion": true,    "follower_and_email_cc_collaborations": false,    "has_color_text": true,    "is_first_comment_private_enabled": true,    "light_agent_email_ccs_allowed": false,    "list_empty_views": true,    "list_newest_comments_first": true,    "markdown_ticket_comments": false,    "maximum_personal_views_to_list": 8,    "modern_ticket_reassignment": false,    "private_attachments": false,    "rich_text_comments": true,    "show_modern_ticket_reassignment": false,    "status_hold": false,    "tagging": true,    "using_skill_based_routing": false  },  "twitter": {    "shorten_url": "optional"  },  "user": {    "agent_created_welcome_emails": true,    "end_user_phone_number_validation": false,    "have_gravatars_enabled": true,    "language_selection": true,    "multiple_organizations": false,    "tagging": true,    "time_zone_selection": true  },  "voice": {    "agent_confirmation_when_forwarding": true,    "agent_wrap_up_after_calls": true,    "enabled": true,    "logging": true,    "maximum_queue_size": 5,    "maximum_queue_wait_time": 1,    "only_during_business_hours": false,    "outbound_enabled": true,    "recordings_public": true,    "uk_mobile_forwarding": true  }}

Show Settings

  • GET /api/v2/account/settings

Shows the settings that are available for the account.

Allowed For

  • Agents

Code Samples

curl
curl https://{subdomain}.zendesk.com/api/v2/account/settings.json \  -v -u {email_address}/token:{api_token}
Go
import (	"fmt"	"io"	"net/http")
func main() {	url := "https://example.zendesk.com/api/v2/account/settings"	method := "GET"	req, err := http.NewRequest(method, url, nil)
	if err != nil {		fmt.Println(err)		return	}	req.Header.Add("Content-Type", "application/json")	req.Header.Add("Authorization", "Basic <auth-value>") // Base64 encoded "{email_address}/token:{api_token}"
	client := &http.Client {}	res, err := client.Do(req)	if err != nil {		fmt.Println(err)		return	}	defer res.Body.Close()
	body, err := io.ReadAll(res.Body)	if err != nil {		fmt.Println(err)		return	}	fmt.Println(string(body))}
Java
import com.squareup.okhttp.*;OkHttpClient client = new OkHttpClient();HttpUrl.Builder urlBuilder = HttpUrl.parse("https://example.zendesk.com/api/v2/account/settings")		.newBuilder();String userCredentials = "your_email_address" + "/token:" + "your_api_token";String basicAuth = "Basic " + java.util.Base64.getEncoder().encodeToString(userCredentials.getBytes());
Request request = new Request.Builder()		.url(urlBuilder.build())		.method("GET", null)		.addHeader("Content-Type", "application/json")		.addHeader("Authorization", basicAuth)		.build();Response response = client.newCall(request).execute();
Nodejs
var axios = require('axios');
var config = {  method: 'GET',  url: 'https://example.zendesk.com/api/v2/account/settings',  headers: {	'Content-Type': 'application/json',	'Authorization': 'Basic <auth-value>', // Base64 encoded "{email_address}/token:{api_token}"  },};
axios(config).then(function (response) {  console.log(JSON.stringify(response.data));}).catch(function (error) {  console.log(error);});
Python
import requestsfrom requests.auth import HTTPBasicAuth
url = "https://example.zendesk.com/api/v2/account/settings"headers = {	"Content-Type": "application/json",}email_address = 'your_email_address'api_token = 'your_api_token'# Use basic authenticationauth = HTTPBasicAuth(f'{email_address}/token', api_token)
response = requests.request(	"GET",	url,	auth=auth,	headers=headers)
print(response.text)
Ruby
require "net/http"require "base64"uri = URI("https://example.zendesk.com/api/v2/account/settings")request = Net::HTTP::Get.new(uri, "Content-Type": "application/json")email = "your_email_address"api_token = "your_api_token"credentials = "#{email}/token:#{api_token}"encoded_credentials = Base64.strict_encode64(credentials)request["Authorization"] = "Basic #{encoded_credentials}"response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|	http.request(request)end

Example response(s)

200 OK
// Status 200 OK
{  "settings": {    "active_features": {      "advanced_analytics": false,      "agent_forwarding": false,      "allow_ccs": true,      "allow_email_template_customization": true,      "automatic_answers": false,      "bcc_archiving": false,      "benchmark_opt_out": false,      "business_hours": false,      "chat": false,      "chat_about_my_ticket": false,      "csat_reason_code": false,      "custom_dkim_domain": true,      "customer_context_as_default": false,      "customer_satisfaction": false,      "dynamic_contents": false,      "explore": true,      "explore_on_support_ent_plan": false,      "explore_on_support_pro_plan": false,      "facebook": false,      "facebook_login": false,      "fallback_composer": false,      "forum_analytics": true,      "good_data_and_explore": false,      "google_login": false,      "insights": false,      "is_abusive": false,      "light_agents": false,      "markdown": false,      "on_hold_status": false,      "organization_access_enabled": true,      "rich_content_in_emails": true,      "sandbox": false,      "satisfaction_prediction": false,      "suspended_ticket_notification": false,      "ticket_forms": true,      "ticket_tagging": true,      "topic_suggestion": false,      "twitter": true,      "twitter_login": false,      "user_org_fields": true,      "user_tagging": true,      "voice": true    },    "agents": {      "agent_home": false,      "agent_workspace": false,      "aw_self_serve_migration_enabled": true,      "focus_mode": false,      "idle_timeout_enabled": false,      "unified_agent_statuses": false    },    "api": {      "accepted_api_agreement": true,      "api_password_access": "true",      "api_token_access": "true"    },    "apps": {      "create_private": true,      "create_public": false,      "use": true    },    "billing": {      "backend": "zuora"    },    "branding": {      "favicon_url": null,      "header_color": "78A300",      "header_logo_url": null,      "page_background_color": "333333",      "tab_background_color": "7FA239",      "text_color": "FFFFFF"    },    "brands": {      "default_brand_id": 1873,      "require_brand_on_new_tickets": false    },    "cdn": {      "cdn_provider": "default",      "fallback_cdn_provider": "cloudfront",      "hosts": [        {          "name": "default",          "url": "https://p18.zdassets.com"        },        {          "name": "cloudfront",          "url": "https://d2y9oszrd3dhjh.cloudfront.net"        }      ]    },    "chat": {      "available": true,      "enabled": false,      "integrated": true,      "maximum_request_count": 1,      "welcome_message": "Hi there. How can I help today?"    },    "cross_sell": {      "show_chat_tooltip": true,      "xsell_source": null    },    "gooddata_advanced_analytics": {      "enabled": true    },    "google_apps": {      "has_google_apps": false,      "has_google_apps_admin": false    },    "groups": {      "check_group_name_uniqueness": true    },    "limits": {      "attachment_size": 52428800    },    "localization": {      "locale_ids": [        1042      ]    },    "lotus": {      "pod_id": 999,      "prefer_lotus": true,      "reporting": true    },    "metrics": {      "account_size": "100-399"    },    "onboarding": {      "checklist_onboarding_version": 2,      "onboarding_segments": null,      "product_sign_up": null    },    "routing": {      "autorouting_tag": "",      "enabled": false,      "max_email_capacity": 0,      "max_messaging_capacity": 0    },    "rule": {      "macro_most_used": true,      "macro_order": "alphabetical",      "skill_based_filtered_views": [],      "using_skill_based_routing": false    },    "side_conversations": {      "email_channel": false,      "msteams_channel": false,      "show_in_context_panel": false,      "slack_channel": false,      "tickets_channel": false    },    "statistics": {      "forum": true,      "rule_usage": true,      "search": true    },    "ticket_form": {      "raw_ticket_forms_instructions": "Please choose your issue below",      "ticket_forms_instructions": "Please choose your issue below"    },    "tickets": {      "accepted_new_collaboration_tos": false,      "agent_collision": true,      "agent_invitation_enabled": true,      "agent_ticket_deletion": false,      "allow_group_reset": true,      "assign_default_organization": true,      "assign_tickets_upon_solve": true,      "auto_translation_enabled": false,      "auto_updated_ccs_followers_rules": false,      "chat_sla_enablement": false,      "collaboration": true,      "comments_public_by_default": true,      "default_solved_ticket_reassignment_strategy": "legacy",      "email_attachments": false,      "emoji_autocompletion": true,      "follower_and_email_cc_collaborations": false,      "has_color_text": true,      "is_first_comment_private_enabled": true,      "light_agent_email_ccs_allowed": false,      "list_empty_views": true,      "list_newest_comments_first": true,      "markdown_ticket_comments": false,      "maximum_personal_views_to_list": 8,      "modern_ticket_reassignment": false,      "private_attachments": false,      "rich_text_comments": true,      "show_modern_ticket_reassignment": false,      "status_hold": false,      "tagging": true,      "using_skill_based_routing": false    },    "twitter": {      "shorten_url": "optional"    },    "user": {      "agent_created_welcome_emails": true,      "end_user_phone_number_validation": false,      "have_gravatars_enabled": true,      "language_selection": true,      "multiple_organizations": false,      "tagging": true,      "time_zone_selection": true    },    "voice": {      "agent_confirmation_when_forwarding": true,      "agent_wrap_up_after_calls": true,      "enabled": true,      "logging": true,      "maximum_queue_size": 5,      "maximum_queue_wait_time": 1,      "only_during_business_hours": false,      "outbound_enabled": true,      "recordings_public": true,      "uk_mobile_forwarding": true    }  }}

Update Account Settings

  • PUT /api/v2/account/settings

Updates settings for the account. See JSON Format above for the settings you can update.

Allowed For

  • Admins

Code Samples

curl
curl https://{subdomain}.zendesk.com/api/v2/account/settings.json \  -H "Content-Type: application/json" -X PUT \  -d '{ "settings": { "active_features": { "customer_satisfaction": false }}}' \  -v -u {email_address}/token:{api_token}
Go
import (	"fmt"	"io"	"net/http")
func main() {	url := "https://example.zendesk.com/api/v2/account/settings"	method := "PUT"	req, err := http.NewRequest(method, url, nil)
	if err != nil {		fmt.Println(err)		return	}	req.Header.Add("Content-Type", "application/json")	req.Header.Add("Authorization", "Basic <auth-value>") // Base64 encoded "{email_address}/token:{api_token}"
	client := &http.Client {}	res, err := client.Do(req)	if err != nil {		fmt.Println(err)		return	}	defer res.Body.Close()
	body, err := io.ReadAll(res.Body)	if err != nil {		fmt.Println(err)		return	}	fmt.Println(string(body))}
Java
import com.squareup.okhttp.*;OkHttpClient client = new OkHttpClient();HttpUrl.Builder urlBuilder = HttpUrl.parse("https://example.zendesk.com/api/v2/account/settings")		.newBuilder();RequestBody body = RequestBody.create(MediaType.parse("application/json"),		"""""");String userCredentials = "your_email_address" + "/token:" + "your_api_token";String basicAuth = "Basic " + java.util.Base64.getEncoder().encodeToString(userCredentials.getBytes());
Request request = new Request.Builder()		.url(urlBuilder.build())		.method("PUT", body)		.addHeader("Content-Type", "application/json")		.addHeader("Authorization", basicAuth)		.build();Response response = client.newCall(request).execute();
Nodejs
var axios = require('axios');
var config = {  method: 'PUT',  url: 'https://example.zendesk.com/api/v2/account/settings',  headers: {	'Content-Type': 'application/json',	'Authorization': 'Basic <auth-value>', // Base64 encoded "{email_address}/token:{api_token}"  },};
axios(config).then(function (response) {  console.log(JSON.stringify(response.data));}).catch(function (error) {  console.log(error);});
Python
import requestsfrom requests.auth import HTTPBasicAuth
url = "https://example.zendesk.com/api/v2/account/settings"headers = {	"Content-Type": "application/json",}email_address = 'your_email_address'api_token = 'your_api_token'# Use basic authenticationauth = HTTPBasicAuth(f'{email_address}/token', api_token)
response = requests.request(	"PUT",	url,	auth=auth,	headers=headers)
print(response.text)
Ruby
require "net/http"require "base64"uri = URI("https://example.zendesk.com/api/v2/account/settings")request = Net::HTTP::Put.new(uri, "Content-Type": "application/json")email = "your_email_address"api_token = "your_api_token"credentials = "#{email}/token:#{api_token}"encoded_credentials = Base64.strict_encode64(credentials)request["Authorization"] = "Basic #{encoded_credentials}"response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|	http.request(request)end

Example response(s)

200 OK
// Status 200 OK
{  "settings": {    "active_features": {      "advanced_analytics": false,      "agent_forwarding": false,      "allow_ccs": true,      "allow_email_template_customization": true,      "automatic_answers": false,      "bcc_archiving": false,      "benchmark_opt_out": false,      "business_hours": false,      "chat": false,      "chat_about_my_ticket": false,      "csat_reason_code": false,      "custom_dkim_domain": true,      "customer_context_as_default": false,      "customer_satisfaction": false,      "dynamic_contents": false,      "explore": true,      "explore_on_support_ent_plan": false,      "explore_on_support_pro_plan": false,      "facebook": false,      "facebook_login": false,      "fallback_composer": false,      "forum_analytics": true,      "good_data_and_explore": false,      "google_login": false,      "insights": false,      "is_abusive": false,      "light_agents": false,      "markdown": false,      "on_hold_status": false,      "organization_access_enabled": true,      "rich_content_in_emails": true,      "sandbox": false,      "satisfaction_prediction": false,      "suspended_ticket_notification": false,      "ticket_forms": true,      "ticket_tagging": true,      "topic_suggestion": false,      "twitter": true,      "twitter_login": false,      "user_org_fields": true,      "user_tagging": true,      "voice": true    },    "agents": {      "agent_home": false,      "agent_workspace": false,      "aw_self_serve_migration_enabled": true,      "focus_mode": false,      "idle_timeout_enabled": false,      "unified_agent_statuses": false    },    "api": {      "accepted_api_agreement": true,      "api_password_access": "true",      "api_token_access": "true"    },    "apps": {      "create_private": true,      "create_public": false,      "use": true    },    "billing": {      "backend": "zuora"    },    "branding": {      "favicon_url": null,      "header_color": "78A300",      "header_logo_url": null,      "page_background_color": "333333",      "tab_background_color": "7FA239",      "text_color": "FFFFFF"    },    "brands": {      "default_brand_id": 1873,      "require_brand_on_new_tickets": false    },    "cdn": {      "cdn_provider": "default",      "fallback_cdn_provider": "cloudfront",      "hosts": [        {          "name": "default",          "url": "https://p18.zdassets.com"        },        {          "name": "cloudfront",          "url": "https://d2y9oszrd3dhjh.cloudfront.net"        }      ]    },    "chat": {      "available": true,      "enabled": false,      "integrated": true,      "maximum_request_count": 1,      "welcome_message": "Hi there. How can I help today?"    },    "cross_sell": {      "show_chat_tooltip": true,      "xsell_source": null    },    "gooddata_advanced_analytics": {      "enabled": true    },    "google_apps": {      "has_google_apps": false,      "has_google_apps_admin": false    },    "groups": {      "check_group_name_uniqueness": true    },    "limits": {      "attachment_size": 52428800    },    "localization": {      "locale_ids": [        1042      ]    },    "lotus": {      "pod_id": 999,      "prefer_lotus": true,      "reporting": true    },    "metrics": {      "account_size": "100-399"    },    "onboarding": {      "checklist_onboarding_version": 2,      "onboarding_segments": null,      "product_sign_up": null    },    "routing": {      "autorouting_tag": "",      "enabled": false,      "max_email_capacity": 0,      "max_messaging_capacity": 0    },    "rule": {      "macro_most_used": true,      "macro_order": "alphabetical",      "skill_based_filtered_views": [],      "using_skill_based_routing": false    },    "side_conversations": {      "email_channel": false,      "msteams_channel": false,      "show_in_context_panel": false,      "slack_channel": false,      "tickets_channel": false    },    "statistics": {      "forum": true,      "rule_usage": true,      "search": true    },    "ticket_form": {      "raw_ticket_forms_instructions": "Please choose your issue below",      "ticket_forms_instructions": "Please choose your issue below"    },    "tickets": {      "accepted_new_collaboration_tos": false,      "agent_collision": true,      "agent_invitation_enabled": true,      "agent_ticket_deletion": false,      "allow_group_reset": true,      "assign_default_organization": true,      "assign_tickets_upon_solve": true,      "auto_translation_enabled": false,      "auto_updated_ccs_followers_rules": false,      "chat_sla_enablement": false,      "collaboration": true,      "comments_public_by_default": true,      "default_solved_ticket_reassignment_strategy": "legacy",      "email_attachments": false,      "emoji_autocompletion": true,      "follower_and_email_cc_collaborations": false,      "has_color_text": true,      "is_first_comment_private_enabled": true,      "light_agent_email_ccs_allowed": false,      "list_empty_views": true,      "list_newest_comments_first": true,      "markdown_ticket_comments": false,      "maximum_personal_views_to_list": 8,      "modern_ticket_reassignment": false,      "private_attachments": false,      "rich_text_comments": true,      "show_modern_ticket_reassignment": false,      "status_hold": false,      "tagging": true,      "using_skill_based_routing": false    },    "twitter": {      "shorten_url": "optional"    },    "user": {      "agent_created_welcome_emails": true,      "end_user_phone_number_validation": false,      "have_gravatars_enabled": true,      "language_selection": true,      "multiple_organizations": false,      "tagging": true,      "time_zone_selection": true    },    "voice": {      "agent_confirmation_when_forwarding": true,      "agent_wrap_up_after_calls": true,      "enabled": true,      "logging": true,      "maximum_queue_size": 5,      "maximum_queue_wait_time": 1,      "only_during_business_hours": false,      "outbound_enabled": true,      "recordings_public": true,      "uk_mobile_forwarding": true    }  }}