Chilkat Online Tools

C++ / Support API / Update Account Settings

Back to Collection Items

#include <CkHttp.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse *resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/account/settings");
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *name = 0;
    const char *url = 0;
    const char *strVal = 0;
    const char *in523 = 0;
    const char *estc = 0;

    const char *Advanced_analytics = jResp.stringOf("settings.active_features.advanced_analytics");
    const char *Agent_forwarding = jResp.stringOf("settings.active_features.agent_forwarding");
    const char *Allow_ccs = jResp.stringOf("settings.active_features.allow_ccs");
    const char *Allow_email_template_customization = jResp.stringOf("settings.active_features.allow_email_template_customization");
    const char *Automatic_answers = jResp.stringOf("settings.active_features.automatic_answers");
    const char *Bcc_archiving = jResp.stringOf("settings.active_features.bcc_archiving");
    const char *Benchmark_opt_out = jResp.stringOf("settings.active_features.benchmark_opt_out");
    const char *Business_hours = jResp.stringOf("settings.active_features.business_hours");
    const char *Chat = jResp.stringOf("settings.active_features.chat");
    const char *Chat_about_my_ticket = jResp.stringOf("settings.active_features.chat_about_my_ticket");
    const char *Csat_reason_code = jResp.stringOf("settings.active_features.csat_reason_code");
    const char *Custom_dkim_domain = jResp.stringOf("settings.active_features.custom_dkim_domain");
    const char *Customer_context_as_default = jResp.stringOf("settings.active_features.customer_context_as_default");
    const char *Customer_satisfaction = jResp.stringOf("settings.active_features.customer_satisfaction");
    const char *Dynamic_contents = jResp.stringOf("settings.active_features.dynamic_contents");
    const char *Explore = jResp.stringOf("settings.active_features.explore");
    const char *Explore_on_support_ent_plan = jResp.stringOf("settings.active_features.explore_on_support_ent_plan");
    const char *Explore_on_support_pro_plan = jResp.stringOf("settings.active_features.explore_on_support_pro_plan");
    const char *Facebook = jResp.stringOf("settings.active_features.facebook");
    const char *Facebook_login = jResp.stringOf("settings.active_features.facebook_login");
    const char *Fallback_composer = jResp.stringOf("settings.active_features.fallback_composer");
    const char *Forum_analytics = jResp.stringOf("settings.active_features.forum_analytics");
    const char *Good_data_and_explore = jResp.stringOf("settings.active_features.good_data_and_explore");
    const char *Google_login = jResp.stringOf("settings.active_features.google_login");
    const char *Insights = jResp.stringOf("settings.active_features.insights");
    const char *Is_abusive = jResp.stringOf("settings.active_features.is_abusive");
    const char *Light_agents = jResp.stringOf("settings.active_features.light_agents");
    const char *Markdown = jResp.stringOf("settings.active_features.markdown");
    const char *On_hold_status = jResp.stringOf("settings.active_features.on_hold_status");
    const char *Rich_content_in_emails = jResp.stringOf("settings.active_features.rich_content_in_emails");
    const char *Sandbox = jResp.stringOf("settings.active_features.sandbox");
    const char *Satisfaction_prediction = jResp.stringOf("settings.active_features.satisfaction_prediction");
    const char *Suspended_ticket_notification = jResp.stringOf("settings.active_features.suspended_ticket_notification");
    const char *Ticket_forms = jResp.stringOf("settings.active_features.ticket_forms");
    const char *Ticket_tagging = jResp.stringOf("settings.active_features.ticket_tagging");
    const char *Topic_suggestion = jResp.stringOf("settings.active_features.topic_suggestion");
    const char *Twitter = jResp.stringOf("settings.active_features.twitter");
    const char *Twitter_login = jResp.stringOf("settings.active_features.twitter_login");
    const char *User_org_fields = jResp.stringOf("settings.active_features.user_org_fields");
    const char *User_tagging = jResp.stringOf("settings.active_features.user_tagging");
    const char *Voice = jResp.stringOf("settings.active_features.voice");
    const char *Agent_workspace = jResp.stringOf("settings.agents.agent_workspace");
    const char *Aw_self_serve_migration_enabled = jResp.stringOf("settings.agents.aw_self_serve_migration_enabled");
    const char *Focus_mode = jResp.stringOf("settings.agents.focus_mode");
    const char *Idle_timeout_enabled = jResp.stringOf("settings.agents.idle_timeout_enabled");
    const char *Unified_agent_statuses = jResp.stringOf("settings.agents.unified_agent_statuses");
    const char *Accepted_api_agreement = jResp.stringOf("settings.api.accepted_api_agreement");
    const char *Api_password_access = jResp.stringOf("settings.api.api_password_access");
    const char *Api_token_access = jResp.stringOf("settings.api.api_token_access");
    const char *Create_private = jResp.stringOf("settings.apps.create_private");
    const char *Create_public = jResp.stringOf("settings.apps.create_public");
    const char *Use = jResp.stringOf("settings.apps.use");
    const char *Backend = jResp.stringOf("settings.billing.backend");
    const char *Favicon_url = jResp.stringOf("settings.branding.favicon_url");
    const char *Header_color = jResp.stringOf("settings.branding.header_color");
    const char *Header_logo_url = jResp.stringOf("settings.branding.header_logo_url");
    const char *Page_background_color = jResp.stringOf("settings.branding.page_background_color");
    const char *Tab_background_color = jResp.stringOf("settings.branding.tab_background_color");
    const char *Text_color = jResp.stringOf("settings.branding.text_color");
    const char *Default_brand_id = jResp.stringOf("settings.brands.default_brand_id");
    const char *Require_brand_on_new_tickets = jResp.stringOf("settings.brands.require_brand_on_new_tickets");
    const char *Cdn_provider = jResp.stringOf("settings.cdn.cdn_provider");
    const char *Fallback_cdn_provider = jResp.stringOf("settings.cdn.fallback_cdn_provider");
    const char *Available = jResp.stringOf("settings.chat.available");
    const char *Enabled = jResp.stringOf("settings.chat.enabled");
    const char *Integrated = jResp.stringOf("settings.chat.integrated");
    const char *Maximum_request_count = jResp.stringOf("settings.chat.maximum_request_count");
    const char *Welcome_message = jResp.stringOf("settings.chat.welcome_message");
    const char *Show_chat_tooltip = jResp.stringOf("settings.cross_sell.show_chat_tooltip");
    const char *Xsell_source = jResp.stringOf("settings.cross_sell.xsell_source");
    const char *Gooddata_advanced_analyticsEnabled = jResp.stringOf("settings.gooddata_advanced_analytics.enabled");
    const char *Has_google_apps = jResp.stringOf("settings.google_apps.has_google_apps");
    const char *Has_google_apps_admin = jResp.stringOf("settings.google_apps.has_google_apps_admin");
    const char *Check_group_name_uniqueness = jResp.stringOf("settings.groups.check_group_name_uniqueness");
    const char *Attachment_size = jResp.stringOf("settings.limits.attachment_size");
    const char *Pod_id = jResp.stringOf("settings.lotus.pod_id");
    const char *Prefer_lotus = jResp.stringOf("settings.lotus.prefer_lotus");
    const char *Reporting = jResp.stringOf("settings.lotus.reporting");
    const char *Account_size = jResp.stringOf("settings.metrics.account_size");
    const char *Checklist_onboarding_version = jResp.stringOf("settings.onboarding.checklist_onboarding_version");
    const char *Onboarding_segments = jResp.stringOf("settings.onboarding.onboarding_segments");
    const char *Product_sign_up = jResp.stringOf("settings.onboarding.product_sign_up");
    const char *Autorouting_tag = jResp.stringOf("settings.routing.autorouting_tag");
    const char *RoutingEnabled = jResp.stringOf("settings.routing.enabled");
    const char *Max_email_capacity = jResp.stringOf("settings.routing.max_email_capacity");
    const char *Max_messaging_capacity = jResp.stringOf("settings.routing.max_messaging_capacity");
    const char *Reassignment_messaging_enabled = jResp.stringOf("settings.routing.reassignment_messaging_enabled");
    const char *Reassignment_messaging_timeout = jResp.stringOf("settings.routing.reassignment_messaging_timeout");
    const char *Reassignment_talk_timeout = jResp.stringOf("settings.routing.reassignment_talk_timeout");
    const char *Macro_most_used = jResp.stringOf("settings.rule.macro_most_used");
    const char *Macro_order = jResp.stringOf("settings.rule.macro_order");
    const char *Using_skill_based_routing = jResp.stringOf("settings.rule.using_skill_based_routing");
    const char *Email_channel = jResp.stringOf("settings.side_conversations.email_channel");
    const char *Msteams_channel = jResp.stringOf("settings.side_conversations.msteams_channel");
    const char *Show_in_context_panel = jResp.stringOf("settings.side_conversations.show_in_context_panel");
    const char *Slack_channel = jResp.stringOf("settings.side_conversations.slack_channel");
    const char *Tickets_channel = jResp.stringOf("settings.side_conversations.tickets_channel");
    const char *Forum = jResp.stringOf("settings.statistics.forum");
    const char *Rule_usage = jResp.stringOf("settings.statistics.rule_usage");
    const char *Search = jResp.stringOf("settings.statistics.search");
    const char *Raw_ticket_forms_instructions = jResp.stringOf("settings.ticket_form.raw_ticket_forms_instructions");
    const char *Ticket_forms_instructions = jResp.stringOf("settings.ticket_form.ticket_forms_instructions");
    const char *Accepted_new_collaboration_tos = jResp.stringOf("settings.tickets.accepted_new_collaboration_tos");
    const char *Agent_collision = jResp.stringOf("settings.tickets.agent_collision");
    const char *Agent_ticket_deletion = jResp.stringOf("settings.tickets.agent_ticket_deletion");
    const char *Allow_group_reset = jResp.stringOf("settings.tickets.allow_group_reset");
    const char *Assign_default_organization = jResp.stringOf("settings.tickets.assign_default_organization");
    const char *Assign_tickets_upon_solve = jResp.stringOf("settings.tickets.assign_tickets_upon_solve");
    const char *Auto_updated_ccs_followers_rules = jResp.stringOf("settings.tickets.auto_updated_ccs_followers_rules");
    const char *Collaboration = jResp.stringOf("settings.tickets.collaboration");
    const char *Comments_public_by_default = jResp.stringOf("settings.tickets.comments_public_by_default");
    const char *Email_attachments = jResp.stringOf("settings.tickets.email_attachments");
    const char *Emoji_autocompletion = jResp.stringOf("settings.tickets.emoji_autocompletion");
    const char *Follower_and_email_cc_collaborations = jResp.stringOf("settings.tickets.follower_and_email_cc_collaborations");
    const char *Has_color_text = jResp.stringOf("settings.tickets.has_color_text");
    const char *Is_first_comment_private_enabled = jResp.stringOf("settings.tickets.is_first_comment_private_enabled");
    const char *Light_agent_email_ccs_allowed = jResp.stringOf("settings.tickets.light_agent_email_ccs_allowed");
    const char *List_empty_views = jResp.stringOf("settings.tickets.list_empty_views");
    const char *List_newest_comments_first = jResp.stringOf("settings.tickets.list_newest_comments_first");
    const char *Markdown_ticket_comments = jResp.stringOf("settings.tickets.markdown_ticket_comments");
    const char *Maximum_personal_views_to_list = jResp.stringOf("settings.tickets.maximum_personal_views_to_list");
    const char *Private_attachments = jResp.stringOf("settings.tickets.private_attachments");
    const char *Rich_text_comments = jResp.stringOf("settings.tickets.rich_text_comments");
    const char *Status_hold = jResp.stringOf("settings.tickets.status_hold");
    const char *Tagging = jResp.stringOf("settings.tickets.tagging");
    const char *TicketsUsing_skill_based_routing = jResp.stringOf("settings.tickets.using_skill_based_routing");
    const char *Shorten_url = jResp.stringOf("settings.twitter.shorten_url");
    const char *Agent_created_welcome_emails = jResp.stringOf("settings.user.agent_created_welcome_emails");
    const char *End_user_phone_number_validation = jResp.stringOf("settings.user.end_user_phone_number_validation");
    const char *Have_gravatars_enabled = jResp.stringOf("settings.user.have_gravatars_enabled");
    const char *Language_selection = jResp.stringOf("settings.user.language_selection");
    const char *Multiple_organizations = jResp.stringOf("settings.user.multiple_organizations");
    const char *UserTagging = jResp.stringOf("settings.user.tagging");
    const char *Time_zone_selection = jResp.stringOf("settings.user.time_zone_selection");
    const char *Agent_confirmation_when_forwarding = jResp.stringOf("settings.voice.agent_confirmation_when_forwarding");
    const char *Agent_wrap_up_after_calls = jResp.stringOf("settings.voice.agent_wrap_up_after_calls");
    const char *VoiceEnabled = jResp.stringOf("settings.voice.enabled");
    const char *Logging = jResp.stringOf("settings.voice.logging");
    const char *Maximum_queue_size = jResp.stringOf("settings.voice.maximum_queue_size");
    const char *Maximum_queue_wait_time = jResp.stringOf("settings.voice.maximum_queue_wait_time");
    const char *Only_during_business_hours = jResp.stringOf("settings.voice.only_during_business_hours");
    const char *Outbound_enabled = jResp.stringOf("settings.voice.outbound_enabled");
    const char *Recordings_public = jResp.stringOf("settings.voice.recordings_public");
    const char *Uk_mobile_forwarding = jResp.stringOf("settings.voice.uk_mobile_forwarding");
    int i = 0;
    int count_i = jResp.SizeOfArray("settings.cdn.hosts");
    while (i < count_i) {
        jResp.put_I(i);
        name = jResp.stringOf("settings.cdn.hosts[i].name");
        url = jResp.stringOf("settings.cdn.hosts[i].url");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("settings.localization.locale_ids");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("settings.localization.locale_ids[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("settings.rule.skill_based_filtered_views");
    while (i < count_i) {
        jResp.put_I(i);
        in523 = jResp.stringOf("settings.rule.skill_based_filtered_views[i].in523");
        estc = jResp.stringOf("settings.rule.skill_based_filtered_views[i].estc");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("settings.ticket_sharing_partners.support_addresses");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("settings.ticket_sharing_partners.support_addresses[i]");
        i = i + 1;
    }
    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update Account Settings",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/account/settings",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "account",
        "settings"
      ]
    },
    "description": "Updates settings for the account. See [JSON Format](#json-format) above for the settings you can update.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "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}"
    }
  ]
}