Chilkat Online Tools

autoit / Support API / Show Settings

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/account/settings",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "settings": {
;     "active_features": {
;       "advanced_analytics": "<boolean>",
;       "agent_forwarding": "<boolean>",
;       "allow_ccs": "<boolean>",
;       "allow_email_template_customization": "<boolean>",
;       "automatic_answers": "<boolean>",
;       "bcc_archiving": "<boolean>",
;       "benchmark_opt_out": "<boolean>",
;       "business_hours": "<boolean>",
;       "chat": "<boolean>",
;       "chat_about_my_ticket": "<boolean>",
;       "csat_reason_code": "<boolean>",
;       "custom_dkim_domain": "<boolean>",
;       "customer_context_as_default": "<boolean>",
;       "customer_satisfaction": "<boolean>",
;       "dynamic_contents": "<boolean>",
;       "explore": "<boolean>",
;       "explore_on_support_ent_plan": "<boolean>",
;       "explore_on_support_pro_plan": "<boolean>",
;       "facebook": "<boolean>",
;       "facebook_login": "<boolean>",
;       "fallback_composer": "<boolean>",
;       "forum_analytics": "<boolean>",
;       "good_data_and_explore": "<boolean>",
;       "google_login": "<boolean>",
;       "insights": "<boolean>",
;       "is_abusive": "<boolean>",
;       "light_agents": "<boolean>",
;       "markdown": "<boolean>",
;       "on_hold_status": "<boolean>",
;       "rich_content_in_emails": "<boolean>",
;       "sandbox": "<boolean>",
;       "satisfaction_prediction": "<boolean>",
;       "suspended_ticket_notification": "<boolean>",
;       "ticket_forms": "<boolean>",
;       "ticket_tagging": "<boolean>",
;       "topic_suggestion": "<boolean>",
;       "twitter": "<boolean>",
;       "twitter_login": "<boolean>",
;       "user_org_fields": "<boolean>",
;       "user_tagging": "<boolean>",
;       "voice": "<boolean>"
;     },
;     "agents": {
;       "agent_workspace": "<boolean>",
;       "aw_self_serve_migration_enabled": "<boolean>",
;       "focus_mode": "<boolean>",
;       "idle_timeout_enabled": "<boolean>",
;       "unified_agent_statuses": "<boolean>"
;     },
;     "api": {
;       "accepted_api_agreement": "<boolean>",
;       "api_password_access": "<string>",
;       "api_token_access": "<string>"
;     },
;     "apps": {
;       "create_private": "<boolean>",
;       "create_public": "<boolean>",
;       "use": "<boolean>"
;     },
;     "billing": {
;       "backend": "<string>"
;     },
;     "branding": {
;       "favicon_url": "<string>",
;       "header_color": "<string>",
;       "header_logo_url": "<string>",
;       "page_background_color": "<string>",
;       "tab_background_color": "<string>",
;       "text_color": "<string>"
;     },
;     "brands": {
;       "default_brand_id": "<integer>",
;       "require_brand_on_new_tickets": "<boolean>"
;     },
;     "cdn": {
;       "cdn_provider": "<string>",
;       "fallback_cdn_provider": "<string>",
;       "hosts": [
;         {
;           "name": "<string>",
;           "url": "<string>"
;         },
;         {
;           "name": "<string>",
;           "url": "<string>"
;         }
;       ]
;     },
;     "chat": {
;       "available": "<boolean>",
;       "enabled": "<boolean>",
;       "integrated": "<boolean>",
;       "maximum_request_count": "<integer>",
;       "welcome_message": "<string>"
;     },
;     "cross_sell": {
;       "show_chat_tooltip": "<boolean>",
;       "xsell_source": "<string>"
;     },
;     "gooddata_advanced_analytics": {
;       "enabled": "<boolean>"
;     },
;     "google_apps": {
;       "has_google_apps": "<boolean>",
;       "has_google_apps_admin": "<boolean>"
;     },
;     "groups": {
;       "check_group_name_uniqueness": "<boolean>"
;     },
;     "limits": {
;       "attachment_size": "<integer>"
;     },
;     "localization": {
;       "locale_ids": [
;         "<integer>",
;         "<integer>"
;       ]
;     },
;     "lotus": {
;       "pod_id": "<integer>",
;       "prefer_lotus": "<boolean>",
;       "reporting": "<boolean>"
;     },
;     "metrics": {
;       "account_size": "<string>"
;     },
;     "onboarding": {
;       "checklist_onboarding_version": "<integer>",
;       "onboarding_segments": "<string>",
;       "product_sign_up": "<string>"
;     },
;     "routing": {
;       "autorouting_tag": "<string>",
;       "enabled": "<boolean>",
;       "max_email_capacity": "<integer>",
;       "max_messaging_capacity": "<integer>",
;       "reassignment_messaging_enabled": "<boolean>",
;       "reassignment_messaging_timeout": "<integer>",
;       "reassignment_talk_timeout": "<integer>"
;     },
;     "rule": {
;       "macro_most_used": "<boolean>",
;       "macro_order": "<string>",
;       "skill_based_filtered_views": [
;         {
;           "in523": 60303840.72385332
;         },
;         {
;           "estc": "eu aliquip id"
;         }
;       ],
;       "using_skill_based_routing": "<boolean>"
;     },
;     "side_conversations": {
;       "email_channel": "<boolean>",
;       "msteams_channel": "<boolean>",
;       "show_in_context_panel": "<boolean>",
;       "slack_channel": "<boolean>",
;       "tickets_channel": "<boolean>"
;     },
;     "statistics": {
;       "forum": "<boolean>",
;       "rule_usage": "<boolean>",
;       "search": "<boolean>"
;     },
;     "ticket_form": {
;       "raw_ticket_forms_instructions": "<string>",
;       "ticket_forms_instructions": "<string>"
;     },
;     "ticket_sharing_partners": {
;       "support_addresses": [
;         "<string>",
;         "<string>"
;       ]
;     },
;     "tickets": {
;       "accepted_new_collaboration_tos": "<boolean>",
;       "agent_collision": "<boolean>",
;       "agent_ticket_deletion": "<boolean>",
;       "allow_group_reset": "<boolean>",
;       "assign_default_organization": "<boolean>",
;       "assign_tickets_upon_solve": "<boolean>",
;       "auto_updated_ccs_followers_rules": "<boolean>",
;       "collaboration": "<boolean>",
;       "comments_public_by_default": "<boolean>",
;       "email_attachments": "<boolean>",
;       "emoji_autocompletion": "<boolean>",
;       "follower_and_email_cc_collaborations": "<boolean>",
;       "has_color_text": "<boolean>",
;       "is_first_comment_private_enabled": "<boolean>",
;       "light_agent_email_ccs_allowed": "<boolean>",
;       "list_empty_views": "<boolean>",
;       "list_newest_comments_first": "<boolean>",
;       "markdown_ticket_comments": "<boolean>",
;       "maximum_personal_views_to_list": "<integer>",
;       "private_attachments": "<boolean>",
;       "rich_text_comments": "<boolean>",
;       "status_hold": "<boolean>",
;       "tagging": "<boolean>",
;       "using_skill_based_routing": "<boolean>"
;     },
;     "twitter": {
;       "shorten_url": "<string>"
;     },
;     "user": {
;       "agent_created_welcome_emails": "<boolean>",
;       "end_user_phone_number_validation": "<boolean>",
;       "have_gravatars_enabled": "<boolean>",
;       "language_selection": "<boolean>",
;       "multiple_organizations": "<boolean>",
;       "tagging": "<boolean>",
;       "time_zone_selection": "<boolean>"
;     },
;     "voice": {
;       "agent_confirmation_when_forwarding": "<boolean>",
;       "agent_wrap_up_after_calls": "<boolean>",
;       "enabled": "<boolean>",
;       "logging": "<boolean>",
;       "maximum_queue_size": "<integer>",
;       "maximum_queue_wait_time": "<integer>",
;       "only_during_business_hours": "<boolean>",
;       "outbound_enabled": "<boolean>",
;       "recordings_public": "<boolean>",
;       "uk_mobile_forwarding": "<boolean>"
;     }
;   }
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sName
Local $sUrl
Local $strVal
Local $sIn523
Local $sEstc

Local $sAdvanced_analytics = $oJResp.StringOf("settings.active_features.advanced_analytics")
Local $sAgent_forwarding = $oJResp.StringOf("settings.active_features.agent_forwarding")
Local $sAllow_ccs = $oJResp.StringOf("settings.active_features.allow_ccs")
Local $sAllow_email_template_customization = $oJResp.StringOf("settings.active_features.allow_email_template_customization")
Local $sAutomatic_answers = $oJResp.StringOf("settings.active_features.automatic_answers")
Local $sBcc_archiving = $oJResp.StringOf("settings.active_features.bcc_archiving")
Local $sBenchmark_opt_out = $oJResp.StringOf("settings.active_features.benchmark_opt_out")
Local $sBusiness_hours = $oJResp.StringOf("settings.active_features.business_hours")
Local $sChat = $oJResp.StringOf("settings.active_features.chat")
Local $sChat_about_my_ticket = $oJResp.StringOf("settings.active_features.chat_about_my_ticket")
Local $sCsat_reason_code = $oJResp.StringOf("settings.active_features.csat_reason_code")
Local $sCustom_dkim_domain = $oJResp.StringOf("settings.active_features.custom_dkim_domain")
Local $sCustomer_context_as_default = $oJResp.StringOf("settings.active_features.customer_context_as_default")
Local $sCustomer_satisfaction = $oJResp.StringOf("settings.active_features.customer_satisfaction")
Local $sDynamic_contents = $oJResp.StringOf("settings.active_features.dynamic_contents")
Local $sExplore = $oJResp.StringOf("settings.active_features.explore")
Local $sExplore_on_support_ent_plan = $oJResp.StringOf("settings.active_features.explore_on_support_ent_plan")
Local $sExplore_on_support_pro_plan = $oJResp.StringOf("settings.active_features.explore_on_support_pro_plan")
Local $sFacebook = $oJResp.StringOf("settings.active_features.facebook")
Local $sFacebook_login = $oJResp.StringOf("settings.active_features.facebook_login")
Local $sFallback_composer = $oJResp.StringOf("settings.active_features.fallback_composer")
Local $sForum_analytics = $oJResp.StringOf("settings.active_features.forum_analytics")
Local $sGood_data_and_explore = $oJResp.StringOf("settings.active_features.good_data_and_explore")
Local $sGoogle_login = $oJResp.StringOf("settings.active_features.google_login")
Local $sInsights = $oJResp.StringOf("settings.active_features.insights")
Local $sIs_abusive = $oJResp.StringOf("settings.active_features.is_abusive")
Local $sLight_agents = $oJResp.StringOf("settings.active_features.light_agents")
Local $sMarkdown = $oJResp.StringOf("settings.active_features.markdown")
Local $sOn_hold_status = $oJResp.StringOf("settings.active_features.on_hold_status")
Local $sRich_content_in_emails = $oJResp.StringOf("settings.active_features.rich_content_in_emails")
Local $sSandbox = $oJResp.StringOf("settings.active_features.sandbox")
Local $sSatisfaction_prediction = $oJResp.StringOf("settings.active_features.satisfaction_prediction")
Local $sSuspended_ticket_notification = $oJResp.StringOf("settings.active_features.suspended_ticket_notification")
Local $sTicket_forms = $oJResp.StringOf("settings.active_features.ticket_forms")
Local $sTicket_tagging = $oJResp.StringOf("settings.active_features.ticket_tagging")
Local $sTopic_suggestion = $oJResp.StringOf("settings.active_features.topic_suggestion")
Local $sTwitter = $oJResp.StringOf("settings.active_features.twitter")
Local $sTwitter_login = $oJResp.StringOf("settings.active_features.twitter_login")
Local $sUser_org_fields = $oJResp.StringOf("settings.active_features.user_org_fields")
Local $sUser_tagging = $oJResp.StringOf("settings.active_features.user_tagging")
Local $sVoice = $oJResp.StringOf("settings.active_features.voice")
Local $sAgent_workspace = $oJResp.StringOf("settings.agents.agent_workspace")
Local $sAw_self_serve_migration_enabled = $oJResp.StringOf("settings.agents.aw_self_serve_migration_enabled")
Local $sFocus_mode = $oJResp.StringOf("settings.agents.focus_mode")
Local $sIdle_timeout_enabled = $oJResp.StringOf("settings.agents.idle_timeout_enabled")
Local $sUnified_agent_statuses = $oJResp.StringOf("settings.agents.unified_agent_statuses")
Local $sAccepted_api_agreement = $oJResp.StringOf("settings.api.accepted_api_agreement")
Local $sApi_password_access = $oJResp.StringOf("settings.api.api_password_access")
Local $sApi_token_access = $oJResp.StringOf("settings.api.api_token_access")
Local $sCreate_private = $oJResp.StringOf("settings.apps.create_private")
Local $sCreate_public = $oJResp.StringOf("settings.apps.create_public")
Local $sUse = $oJResp.StringOf("settings.apps.use")
Local $sBackend = $oJResp.StringOf("settings.billing.backend")
Local $sFavicon_url = $oJResp.StringOf("settings.branding.favicon_url")
Local $sHeader_color = $oJResp.StringOf("settings.branding.header_color")
Local $sHeader_logo_url = $oJResp.StringOf("settings.branding.header_logo_url")
Local $sPage_background_color = $oJResp.StringOf("settings.branding.page_background_color")
Local $sTab_background_color = $oJResp.StringOf("settings.branding.tab_background_color")
Local $sText_color = $oJResp.StringOf("settings.branding.text_color")
Local $sDefault_brand_id = $oJResp.StringOf("settings.brands.default_brand_id")
Local $sRequire_brand_on_new_tickets = $oJResp.StringOf("settings.brands.require_brand_on_new_tickets")
Local $sCdn_provider = $oJResp.StringOf("settings.cdn.cdn_provider")
Local $sFallback_cdn_provider = $oJResp.StringOf("settings.cdn.fallback_cdn_provider")
Local $sAvailable = $oJResp.StringOf("settings.chat.available")
Local $sEnabled = $oJResp.StringOf("settings.chat.enabled")
Local $sIntegrated = $oJResp.StringOf("settings.chat.integrated")
Local $sMaximum_request_count = $oJResp.StringOf("settings.chat.maximum_request_count")
Local $sWelcome_message = $oJResp.StringOf("settings.chat.welcome_message")
Local $sShow_chat_tooltip = $oJResp.StringOf("settings.cross_sell.show_chat_tooltip")
Local $sXsell_source = $oJResp.StringOf("settings.cross_sell.xsell_source")
Local $sGooddata_advanced_analyticsEnabled = $oJResp.StringOf("settings.gooddata_advanced_analytics.enabled")
Local $sHas_google_apps = $oJResp.StringOf("settings.google_apps.has_google_apps")
Local $sHas_google_apps_admin = $oJResp.StringOf("settings.google_apps.has_google_apps_admin")
Local $sCheck_group_name_uniqueness = $oJResp.StringOf("settings.groups.check_group_name_uniqueness")
Local $sAttachment_size = $oJResp.StringOf("settings.limits.attachment_size")
Local $sPod_id = $oJResp.StringOf("settings.lotus.pod_id")
Local $sPrefer_lotus = $oJResp.StringOf("settings.lotus.prefer_lotus")
Local $sReporting = $oJResp.StringOf("settings.lotus.reporting")
Local $sAccount_size = $oJResp.StringOf("settings.metrics.account_size")
Local $sChecklist_onboarding_version = $oJResp.StringOf("settings.onboarding.checklist_onboarding_version")
Local $sOnboarding_segments = $oJResp.StringOf("settings.onboarding.onboarding_segments")
Local $sProduct_sign_up = $oJResp.StringOf("settings.onboarding.product_sign_up")
Local $sAutorouting_tag = $oJResp.StringOf("settings.routing.autorouting_tag")
Local $sRoutingEnabled = $oJResp.StringOf("settings.routing.enabled")
Local $sMax_email_capacity = $oJResp.StringOf("settings.routing.max_email_capacity")
Local $sMax_messaging_capacity = $oJResp.StringOf("settings.routing.max_messaging_capacity")
Local $sReassignment_messaging_enabled = $oJResp.StringOf("settings.routing.reassignment_messaging_enabled")
Local $sReassignment_messaging_timeout = $oJResp.StringOf("settings.routing.reassignment_messaging_timeout")
Local $sReassignment_talk_timeout = $oJResp.StringOf("settings.routing.reassignment_talk_timeout")
Local $sMacro_most_used = $oJResp.StringOf("settings.rule.macro_most_used")
Local $sMacro_order = $oJResp.StringOf("settings.rule.macro_order")
Local $sUsing_skill_based_routing = $oJResp.StringOf("settings.rule.using_skill_based_routing")
Local $sEmail_channel = $oJResp.StringOf("settings.side_conversations.email_channel")
Local $sMsteams_channel = $oJResp.StringOf("settings.side_conversations.msteams_channel")
Local $sShow_in_context_panel = $oJResp.StringOf("settings.side_conversations.show_in_context_panel")
Local $sSlack_channel = $oJResp.StringOf("settings.side_conversations.slack_channel")
Local $sTickets_channel = $oJResp.StringOf("settings.side_conversations.tickets_channel")
Local $sForum = $oJResp.StringOf("settings.statistics.forum")
Local $sRule_usage = $oJResp.StringOf("settings.statistics.rule_usage")
Local $sSearch = $oJResp.StringOf("settings.statistics.search")
Local $sRaw_ticket_forms_instructions = $oJResp.StringOf("settings.ticket_form.raw_ticket_forms_instructions")
Local $sTicket_forms_instructions = $oJResp.StringOf("settings.ticket_form.ticket_forms_instructions")
Local $sAccepted_new_collaboration_tos = $oJResp.StringOf("settings.tickets.accepted_new_collaboration_tos")
Local $sAgent_collision = $oJResp.StringOf("settings.tickets.agent_collision")
Local $sAgent_ticket_deletion = $oJResp.StringOf("settings.tickets.agent_ticket_deletion")
Local $sAllow_group_reset = $oJResp.StringOf("settings.tickets.allow_group_reset")
Local $sAssign_default_organization = $oJResp.StringOf("settings.tickets.assign_default_organization")
Local $sAssign_tickets_upon_solve = $oJResp.StringOf("settings.tickets.assign_tickets_upon_solve")
Local $sAuto_updated_ccs_followers_rules = $oJResp.StringOf("settings.tickets.auto_updated_ccs_followers_rules")
Local $sCollaboration = $oJResp.StringOf("settings.tickets.collaboration")
Local $sComments_public_by_default = $oJResp.StringOf("settings.tickets.comments_public_by_default")
Local $sEmail_attachments = $oJResp.StringOf("settings.tickets.email_attachments")
Local $sEmoji_autocompletion = $oJResp.StringOf("settings.tickets.emoji_autocompletion")
Local $sFollower_and_email_cc_collaborations = $oJResp.StringOf("settings.tickets.follower_and_email_cc_collaborations")
Local $sHas_color_text = $oJResp.StringOf("settings.tickets.has_color_text")
Local $sIs_first_comment_private_enabled = $oJResp.StringOf("settings.tickets.is_first_comment_private_enabled")
Local $sLight_agent_email_ccs_allowed = $oJResp.StringOf("settings.tickets.light_agent_email_ccs_allowed")
Local $sList_empty_views = $oJResp.StringOf("settings.tickets.list_empty_views")
Local $sList_newest_comments_first = $oJResp.StringOf("settings.tickets.list_newest_comments_first")
Local $sMarkdown_ticket_comments = $oJResp.StringOf("settings.tickets.markdown_ticket_comments")
Local $sMaximum_personal_views_to_list = $oJResp.StringOf("settings.tickets.maximum_personal_views_to_list")
Local $sPrivate_attachments = $oJResp.StringOf("settings.tickets.private_attachments")
Local $sRich_text_comments = $oJResp.StringOf("settings.tickets.rich_text_comments")
Local $sStatus_hold = $oJResp.StringOf("settings.tickets.status_hold")
Local $sTagging = $oJResp.StringOf("settings.tickets.tagging")
Local $sTicketsUsing_skill_based_routing = $oJResp.StringOf("settings.tickets.using_skill_based_routing")
Local $sShorten_url = $oJResp.StringOf("settings.twitter.shorten_url")
Local $sAgent_created_welcome_emails = $oJResp.StringOf("settings.user.agent_created_welcome_emails")
Local $sEnd_user_phone_number_validation = $oJResp.StringOf("settings.user.end_user_phone_number_validation")
Local $sHave_gravatars_enabled = $oJResp.StringOf("settings.user.have_gravatars_enabled")
Local $sLanguage_selection = $oJResp.StringOf("settings.user.language_selection")
Local $sMultiple_organizations = $oJResp.StringOf("settings.user.multiple_organizations")
Local $sUserTagging = $oJResp.StringOf("settings.user.tagging")
Local $sTime_zone_selection = $oJResp.StringOf("settings.user.time_zone_selection")
Local $sAgent_confirmation_when_forwarding = $oJResp.StringOf("settings.voice.agent_confirmation_when_forwarding")
Local $sAgent_wrap_up_after_calls = $oJResp.StringOf("settings.voice.agent_wrap_up_after_calls")
Local $sVoiceEnabled = $oJResp.StringOf("settings.voice.enabled")
Local $sLogging = $oJResp.StringOf("settings.voice.logging")
Local $sMaximum_queue_size = $oJResp.StringOf("settings.voice.maximum_queue_size")
Local $sMaximum_queue_wait_time = $oJResp.StringOf("settings.voice.maximum_queue_wait_time")
Local $sOnly_during_business_hours = $oJResp.StringOf("settings.voice.only_during_business_hours")
Local $sOutbound_enabled = $oJResp.StringOf("settings.voice.outbound_enabled")
Local $sRecordings_public = $oJResp.StringOf("settings.voice.recordings_public")
Local $sUk_mobile_forwarding = $oJResp.StringOf("settings.voice.uk_mobile_forwarding")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("settings.cdn.hosts")
While $i < $iCount_i
    $oJResp.I = $i
    $sName = $oJResp.StringOf("settings.cdn.hosts[i].name")
    $sUrl = $oJResp.StringOf("settings.cdn.hosts[i].url")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("settings.localization.locale_ids")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("settings.localization.locale_ids[i]")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("settings.rule.skill_based_filtered_views")
While $i < $iCount_i
    $oJResp.I = $i
    $sIn523 = $oJResp.StringOf("settings.rule.skill_based_filtered_views[i].in523")
    $sEstc = $oJResp.StringOf("settings.rule.skill_based_filtered_views[i].estc")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("settings.ticket_sharing_partners.support_addresses")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("settings.ticket_sharing_partners.support_addresses[i]")
    $i = $i + 1
Wend

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/account/settings

Postman Collection Item JSON

{
  "name": "Show Settings",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/account/settings",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "account",
        "settings"
      ]
    },
    "description": "Shows the settings that are available for the account.\n\n#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/account/settings",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "account",
            "settings"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"settings\": {\n    \"active_features\": {\n      \"advanced_analytics\": \"<boolean>\",\n      \"agent_forwarding\": \"<boolean>\",\n      \"allow_ccs\": \"<boolean>\",\n      \"allow_email_template_customization\": \"<boolean>\",\n      \"automatic_answers\": \"<boolean>\",\n      \"bcc_archiving\": \"<boolean>\",\n      \"benchmark_opt_out\": \"<boolean>\",\n      \"business_hours\": \"<boolean>\",\n      \"chat\": \"<boolean>\",\n      \"chat_about_my_ticket\": \"<boolean>\",\n      \"csat_reason_code\": \"<boolean>\",\n      \"custom_dkim_domain\": \"<boolean>\",\n      \"customer_context_as_default\": \"<boolean>\",\n      \"customer_satisfaction\": \"<boolean>\",\n      \"dynamic_contents\": \"<boolean>\",\n      \"explore\": \"<boolean>\",\n      \"explore_on_support_ent_plan\": \"<boolean>\",\n      \"explore_on_support_pro_plan\": \"<boolean>\",\n      \"facebook\": \"<boolean>\",\n      \"facebook_login\": \"<boolean>\",\n      \"fallback_composer\": \"<boolean>\",\n      \"forum_analytics\": \"<boolean>\",\n      \"good_data_and_explore\": \"<boolean>\",\n      \"google_login\": \"<boolean>\",\n      \"insights\": \"<boolean>\",\n      \"is_abusive\": \"<boolean>\",\n      \"light_agents\": \"<boolean>\",\n      \"markdown\": \"<boolean>\",\n      \"on_hold_status\": \"<boolean>\",\n      \"rich_content_in_emails\": \"<boolean>\",\n      \"sandbox\": \"<boolean>\",\n      \"satisfaction_prediction\": \"<boolean>\",\n      \"suspended_ticket_notification\": \"<boolean>\",\n      \"ticket_forms\": \"<boolean>\",\n      \"ticket_tagging\": \"<boolean>\",\n      \"topic_suggestion\": \"<boolean>\",\n      \"twitter\": \"<boolean>\",\n      \"twitter_login\": \"<boolean>\",\n      \"user_org_fields\": \"<boolean>\",\n      \"user_tagging\": \"<boolean>\",\n      \"voice\": \"<boolean>\"\n    },\n    \"agents\": {\n      \"agent_workspace\": \"<boolean>\",\n      \"aw_self_serve_migration_enabled\": \"<boolean>\",\n      \"focus_mode\": \"<boolean>\",\n      \"idle_timeout_enabled\": \"<boolean>\",\n      \"unified_agent_statuses\": \"<boolean>\"\n    },\n    \"api\": {\n      \"accepted_api_agreement\": \"<boolean>\",\n      \"api_password_access\": \"<string>\",\n      \"api_token_access\": \"<string>\"\n    },\n    \"apps\": {\n      \"create_private\": \"<boolean>\",\n      \"create_public\": \"<boolean>\",\n      \"use\": \"<boolean>\"\n    },\n    \"billing\": {\n      \"backend\": \"<string>\"\n    },\n    \"branding\": {\n      \"favicon_url\": \"<string>\",\n      \"header_color\": \"<string>\",\n      \"header_logo_url\": \"<string>\",\n      \"page_background_color\": \"<string>\",\n      \"tab_background_color\": \"<string>\",\n      \"text_color\": \"<string>\"\n    },\n    \"brands\": {\n      \"default_brand_id\": \"<integer>\",\n      \"require_brand_on_new_tickets\": \"<boolean>\"\n    },\n    \"cdn\": {\n      \"cdn_provider\": \"<string>\",\n      \"fallback_cdn_provider\": \"<string>\",\n      \"hosts\": [\n        {\n          \"name\": \"<string>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"name\": \"<string>\",\n          \"url\": \"<string>\"\n        }\n      ]\n    },\n    \"chat\": {\n      \"available\": \"<boolean>\",\n      \"enabled\": \"<boolean>\",\n      \"integrated\": \"<boolean>\",\n      \"maximum_request_count\": \"<integer>\",\n      \"welcome_message\": \"<string>\"\n    },\n    \"cross_sell\": {\n      \"show_chat_tooltip\": \"<boolean>\",\n      \"xsell_source\": \"<string>\"\n    },\n    \"gooddata_advanced_analytics\": {\n      \"enabled\": \"<boolean>\"\n    },\n    \"google_apps\": {\n      \"has_google_apps\": \"<boolean>\",\n      \"has_google_apps_admin\": \"<boolean>\"\n    },\n    \"groups\": {\n      \"check_group_name_uniqueness\": \"<boolean>\"\n    },\n    \"limits\": {\n      \"attachment_size\": \"<integer>\"\n    },\n    \"localization\": {\n      \"locale_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ]\n    },\n    \"lotus\": {\n      \"pod_id\": \"<integer>\",\n      \"prefer_lotus\": \"<boolean>\",\n      \"reporting\": \"<boolean>\"\n    },\n    \"metrics\": {\n      \"account_size\": \"<string>\"\n    },\n    \"onboarding\": {\n      \"checklist_onboarding_version\": \"<integer>\",\n      \"onboarding_segments\": \"<string>\",\n      \"product_sign_up\": \"<string>\"\n    },\n    \"routing\": {\n      \"autorouting_tag\": \"<string>\",\n      \"enabled\": \"<boolean>\",\n      \"max_email_capacity\": \"<integer>\",\n      \"max_messaging_capacity\": \"<integer>\",\n      \"reassignment_messaging_enabled\": \"<boolean>\",\n      \"reassignment_messaging_timeout\": \"<integer>\",\n      \"reassignment_talk_timeout\": \"<integer>\"\n    },\n    \"rule\": {\n      \"macro_most_used\": \"<boolean>\",\n      \"macro_order\": \"<string>\",\n      \"skill_based_filtered_views\": [\n        {\n          \"in523\": 60303840.72385332\n        },\n        {\n          \"estc\": \"eu aliquip id\"\n        }\n      ],\n      \"using_skill_based_routing\": \"<boolean>\"\n    },\n    \"side_conversations\": {\n      \"email_channel\": \"<boolean>\",\n      \"msteams_channel\": \"<boolean>\",\n      \"show_in_context_panel\": \"<boolean>\",\n      \"slack_channel\": \"<boolean>\",\n      \"tickets_channel\": \"<boolean>\"\n    },\n    \"statistics\": {\n      \"forum\": \"<boolean>\",\n      \"rule_usage\": \"<boolean>\",\n      \"search\": \"<boolean>\"\n    },\n    \"ticket_form\": {\n      \"raw_ticket_forms_instructions\": \"<string>\",\n      \"ticket_forms_instructions\": \"<string>\"\n    },\n    \"ticket_sharing_partners\": {\n      \"support_addresses\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    },\n    \"tickets\": {\n      \"accepted_new_collaboration_tos\": \"<boolean>\",\n      \"agent_collision\": \"<boolean>\",\n      \"agent_ticket_deletion\": \"<boolean>\",\n      \"allow_group_reset\": \"<boolean>\",\n      \"assign_default_organization\": \"<boolean>\",\n      \"assign_tickets_upon_solve\": \"<boolean>\",\n      \"auto_updated_ccs_followers_rules\": \"<boolean>\",\n      \"collaboration\": \"<boolean>\",\n      \"comments_public_by_default\": \"<boolean>\",\n      \"email_attachments\": \"<boolean>\",\n      \"emoji_autocompletion\": \"<boolean>\",\n      \"follower_and_email_cc_collaborations\": \"<boolean>\",\n      \"has_color_text\": \"<boolean>\",\n      \"is_first_comment_private_enabled\": \"<boolean>\",\n      \"light_agent_email_ccs_allowed\": \"<boolean>\",\n      \"list_empty_views\": \"<boolean>\",\n      \"list_newest_comments_first\": \"<boolean>\",\n      \"markdown_ticket_comments\": \"<boolean>\",\n      \"maximum_personal_views_to_list\": \"<integer>\",\n      \"private_attachments\": \"<boolean>\",\n      \"rich_text_comments\": \"<boolean>\",\n      \"status_hold\": \"<boolean>\",\n      \"tagging\": \"<boolean>\",\n      \"using_skill_based_routing\": \"<boolean>\"\n    },\n    \"twitter\": {\n      \"shorten_url\": \"<string>\"\n    },\n    \"user\": {\n      \"agent_created_welcome_emails\": \"<boolean>\",\n      \"end_user_phone_number_validation\": \"<boolean>\",\n      \"have_gravatars_enabled\": \"<boolean>\",\n      \"language_selection\": \"<boolean>\",\n      \"multiple_organizations\": \"<boolean>\",\n      \"tagging\": \"<boolean>\",\n      \"time_zone_selection\": \"<boolean>\"\n    },\n    \"voice\": {\n      \"agent_confirmation_when_forwarding\": \"<boolean>\",\n      \"agent_wrap_up_after_calls\": \"<boolean>\",\n      \"enabled\": \"<boolean>\",\n      \"logging\": \"<boolean>\",\n      \"maximum_queue_size\": \"<integer>\",\n      \"maximum_queue_wait_time\": \"<integer>\",\n      \"only_during_business_hours\": \"<boolean>\",\n      \"outbound_enabled\": \"<boolean>\",\n      \"recordings_public\": \"<boolean>\",\n      \"uk_mobile_forwarding\": \"<boolean>\"\n    }\n  }\n}"
    }
  ]
}