Objective-C / Support API / Update Account Settings
Back to Collection Items
#import <CkoHttp.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequest: @"PUT" url: @"https://example.zendesk.com/api/v2/account/settings"];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *name = 0;
NSString *url = 0;
NSString *strVal = 0;
NSString *in523 = 0;
NSString *estc = 0;
NSString *Advanced_analytics = [jResp StringOf: @"settings.active_features.advanced_analytics"];
NSString *Agent_forwarding = [jResp StringOf: @"settings.active_features.agent_forwarding"];
NSString *Allow_ccs = [jResp StringOf: @"settings.active_features.allow_ccs"];
NSString *Allow_email_template_customization = [jResp StringOf: @"settings.active_features.allow_email_template_customization"];
NSString *Automatic_answers = [jResp StringOf: @"settings.active_features.automatic_answers"];
NSString *Bcc_archiving = [jResp StringOf: @"settings.active_features.bcc_archiving"];
NSString *Benchmark_opt_out = [jResp StringOf: @"settings.active_features.benchmark_opt_out"];
NSString *Business_hours = [jResp StringOf: @"settings.active_features.business_hours"];
NSString *Chat = [jResp StringOf: @"settings.active_features.chat"];
NSString *Chat_about_my_ticket = [jResp StringOf: @"settings.active_features.chat_about_my_ticket"];
NSString *Csat_reason_code = [jResp StringOf: @"settings.active_features.csat_reason_code"];
NSString *Custom_dkim_domain = [jResp StringOf: @"settings.active_features.custom_dkim_domain"];
NSString *Customer_context_as_default = [jResp StringOf: @"settings.active_features.customer_context_as_default"];
NSString *Customer_satisfaction = [jResp StringOf: @"settings.active_features.customer_satisfaction"];
NSString *Dynamic_contents = [jResp StringOf: @"settings.active_features.dynamic_contents"];
NSString *Explore = [jResp StringOf: @"settings.active_features.explore"];
NSString *Explore_on_support_ent_plan = [jResp StringOf: @"settings.active_features.explore_on_support_ent_plan"];
NSString *Explore_on_support_pro_plan = [jResp StringOf: @"settings.active_features.explore_on_support_pro_plan"];
NSString *Facebook = [jResp StringOf: @"settings.active_features.facebook"];
NSString *Facebook_login = [jResp StringOf: @"settings.active_features.facebook_login"];
NSString *Fallback_composer = [jResp StringOf: @"settings.active_features.fallback_composer"];
NSString *Forum_analytics = [jResp StringOf: @"settings.active_features.forum_analytics"];
NSString *Good_data_and_explore = [jResp StringOf: @"settings.active_features.good_data_and_explore"];
NSString *Google_login = [jResp StringOf: @"settings.active_features.google_login"];
NSString *Insights = [jResp StringOf: @"settings.active_features.insights"];
NSString *Is_abusive = [jResp StringOf: @"settings.active_features.is_abusive"];
NSString *Light_agents = [jResp StringOf: @"settings.active_features.light_agents"];
NSString *Markdown = [jResp StringOf: @"settings.active_features.markdown"];
NSString *On_hold_status = [jResp StringOf: @"settings.active_features.on_hold_status"];
NSString *Rich_content_in_emails = [jResp StringOf: @"settings.active_features.rich_content_in_emails"];
NSString *Sandbox = [jResp StringOf: @"settings.active_features.sandbox"];
NSString *Satisfaction_prediction = [jResp StringOf: @"settings.active_features.satisfaction_prediction"];
NSString *Suspended_ticket_notification = [jResp StringOf: @"settings.active_features.suspended_ticket_notification"];
NSString *Ticket_forms = [jResp StringOf: @"settings.active_features.ticket_forms"];
NSString *Ticket_tagging = [jResp StringOf: @"settings.active_features.ticket_tagging"];
NSString *Topic_suggestion = [jResp StringOf: @"settings.active_features.topic_suggestion"];
NSString *Twitter = [jResp StringOf: @"settings.active_features.twitter"];
NSString *Twitter_login = [jResp StringOf: @"settings.active_features.twitter_login"];
NSString *User_org_fields = [jResp StringOf: @"settings.active_features.user_org_fields"];
NSString *User_tagging = [jResp StringOf: @"settings.active_features.user_tagging"];
NSString *Voice = [jResp StringOf: @"settings.active_features.voice"];
NSString *Agent_workspace = [jResp StringOf: @"settings.agents.agent_workspace"];
NSString *Aw_self_serve_migration_enabled = [jResp StringOf: @"settings.agents.aw_self_serve_migration_enabled"];
NSString *Focus_mode = [jResp StringOf: @"settings.agents.focus_mode"];
NSString *Idle_timeout_enabled = [jResp StringOf: @"settings.agents.idle_timeout_enabled"];
NSString *Unified_agent_statuses = [jResp StringOf: @"settings.agents.unified_agent_statuses"];
NSString *Accepted_api_agreement = [jResp StringOf: @"settings.api.accepted_api_agreement"];
NSString *Api_password_access = [jResp StringOf: @"settings.api.api_password_access"];
NSString *Api_token_access = [jResp StringOf: @"settings.api.api_token_access"];
NSString *Create_private = [jResp StringOf: @"settings.apps.create_private"];
NSString *Create_public = [jResp StringOf: @"settings.apps.create_public"];
NSString *Use = [jResp StringOf: @"settings.apps.use"];
NSString *Backend = [jResp StringOf: @"settings.billing.backend"];
NSString *Favicon_url = [jResp StringOf: @"settings.branding.favicon_url"];
NSString *Header_color = [jResp StringOf: @"settings.branding.header_color"];
NSString *Header_logo_url = [jResp StringOf: @"settings.branding.header_logo_url"];
NSString *Page_background_color = [jResp StringOf: @"settings.branding.page_background_color"];
NSString *Tab_background_color = [jResp StringOf: @"settings.branding.tab_background_color"];
NSString *Text_color = [jResp StringOf: @"settings.branding.text_color"];
NSString *Default_brand_id = [jResp StringOf: @"settings.brands.default_brand_id"];
NSString *Require_brand_on_new_tickets = [jResp StringOf: @"settings.brands.require_brand_on_new_tickets"];
NSString *Cdn_provider = [jResp StringOf: @"settings.cdn.cdn_provider"];
NSString *Fallback_cdn_provider = [jResp StringOf: @"settings.cdn.fallback_cdn_provider"];
NSString *Available = [jResp StringOf: @"settings.chat.available"];
NSString *Enabled = [jResp StringOf: @"settings.chat.enabled"];
NSString *Integrated = [jResp StringOf: @"settings.chat.integrated"];
NSString *Maximum_request_count = [jResp StringOf: @"settings.chat.maximum_request_count"];
NSString *Welcome_message = [jResp StringOf: @"settings.chat.welcome_message"];
NSString *Show_chat_tooltip = [jResp StringOf: @"settings.cross_sell.show_chat_tooltip"];
NSString *Xsell_source = [jResp StringOf: @"settings.cross_sell.xsell_source"];
NSString *Gooddata_advanced_analyticsEnabled = [jResp StringOf: @"settings.gooddata_advanced_analytics.enabled"];
NSString *Has_google_apps = [jResp StringOf: @"settings.google_apps.has_google_apps"];
NSString *Has_google_apps_admin = [jResp StringOf: @"settings.google_apps.has_google_apps_admin"];
NSString *Check_group_name_uniqueness = [jResp StringOf: @"settings.groups.check_group_name_uniqueness"];
NSString *Attachment_size = [jResp StringOf: @"settings.limits.attachment_size"];
NSString *Pod_id = [jResp StringOf: @"settings.lotus.pod_id"];
NSString *Prefer_lotus = [jResp StringOf: @"settings.lotus.prefer_lotus"];
NSString *Reporting = [jResp StringOf: @"settings.lotus.reporting"];
NSString *Account_size = [jResp StringOf: @"settings.metrics.account_size"];
NSString *Checklist_onboarding_version = [jResp StringOf: @"settings.onboarding.checklist_onboarding_version"];
NSString *Onboarding_segments = [jResp StringOf: @"settings.onboarding.onboarding_segments"];
NSString *Product_sign_up = [jResp StringOf: @"settings.onboarding.product_sign_up"];
NSString *Autorouting_tag = [jResp StringOf: @"settings.routing.autorouting_tag"];
NSString *RoutingEnabled = [jResp StringOf: @"settings.routing.enabled"];
NSString *Max_email_capacity = [jResp StringOf: @"settings.routing.max_email_capacity"];
NSString *Max_messaging_capacity = [jResp StringOf: @"settings.routing.max_messaging_capacity"];
NSString *Reassignment_messaging_enabled = [jResp StringOf: @"settings.routing.reassignment_messaging_enabled"];
NSString *Reassignment_messaging_timeout = [jResp StringOf: @"settings.routing.reassignment_messaging_timeout"];
NSString *Reassignment_talk_timeout = [jResp StringOf: @"settings.routing.reassignment_talk_timeout"];
NSString *Macro_most_used = [jResp StringOf: @"settings.rule.macro_most_used"];
NSString *Macro_order = [jResp StringOf: @"settings.rule.macro_order"];
NSString *Using_skill_based_routing = [jResp StringOf: @"settings.rule.using_skill_based_routing"];
NSString *Email_channel = [jResp StringOf: @"settings.side_conversations.email_channel"];
NSString *Msteams_channel = [jResp StringOf: @"settings.side_conversations.msteams_channel"];
NSString *Show_in_context_panel = [jResp StringOf: @"settings.side_conversations.show_in_context_panel"];
NSString *Slack_channel = [jResp StringOf: @"settings.side_conversations.slack_channel"];
NSString *Tickets_channel = [jResp StringOf: @"settings.side_conversations.tickets_channel"];
NSString *Forum = [jResp StringOf: @"settings.statistics.forum"];
NSString *Rule_usage = [jResp StringOf: @"settings.statistics.rule_usage"];
NSString *Search = [jResp StringOf: @"settings.statistics.search"];
NSString *Raw_ticket_forms_instructions = [jResp StringOf: @"settings.ticket_form.raw_ticket_forms_instructions"];
NSString *Ticket_forms_instructions = [jResp StringOf: @"settings.ticket_form.ticket_forms_instructions"];
NSString *Accepted_new_collaboration_tos = [jResp StringOf: @"settings.tickets.accepted_new_collaboration_tos"];
NSString *Agent_collision = [jResp StringOf: @"settings.tickets.agent_collision"];
NSString *Agent_ticket_deletion = [jResp StringOf: @"settings.tickets.agent_ticket_deletion"];
NSString *Allow_group_reset = [jResp StringOf: @"settings.tickets.allow_group_reset"];
NSString *Assign_default_organization = [jResp StringOf: @"settings.tickets.assign_default_organization"];
NSString *Assign_tickets_upon_solve = [jResp StringOf: @"settings.tickets.assign_tickets_upon_solve"];
NSString *Auto_updated_ccs_followers_rules = [jResp StringOf: @"settings.tickets.auto_updated_ccs_followers_rules"];
NSString *Collaboration = [jResp StringOf: @"settings.tickets.collaboration"];
NSString *Comments_public_by_default = [jResp StringOf: @"settings.tickets.comments_public_by_default"];
NSString *Email_attachments = [jResp StringOf: @"settings.tickets.email_attachments"];
NSString *Emoji_autocompletion = [jResp StringOf: @"settings.tickets.emoji_autocompletion"];
NSString *Follower_and_email_cc_collaborations = [jResp StringOf: @"settings.tickets.follower_and_email_cc_collaborations"];
NSString *Has_color_text = [jResp StringOf: @"settings.tickets.has_color_text"];
NSString *Is_first_comment_private_enabled = [jResp StringOf: @"settings.tickets.is_first_comment_private_enabled"];
NSString *Light_agent_email_ccs_allowed = [jResp StringOf: @"settings.tickets.light_agent_email_ccs_allowed"];
NSString *List_empty_views = [jResp StringOf: @"settings.tickets.list_empty_views"];
NSString *List_newest_comments_first = [jResp StringOf: @"settings.tickets.list_newest_comments_first"];
NSString *Markdown_ticket_comments = [jResp StringOf: @"settings.tickets.markdown_ticket_comments"];
NSString *Maximum_personal_views_to_list = [jResp StringOf: @"settings.tickets.maximum_personal_views_to_list"];
NSString *Private_attachments = [jResp StringOf: @"settings.tickets.private_attachments"];
NSString *Rich_text_comments = [jResp StringOf: @"settings.tickets.rich_text_comments"];
NSString *Status_hold = [jResp StringOf: @"settings.tickets.status_hold"];
NSString *Tagging = [jResp StringOf: @"settings.tickets.tagging"];
NSString *TicketsUsing_skill_based_routing = [jResp StringOf: @"settings.tickets.using_skill_based_routing"];
NSString *Shorten_url = [jResp StringOf: @"settings.twitter.shorten_url"];
NSString *Agent_created_welcome_emails = [jResp StringOf: @"settings.user.agent_created_welcome_emails"];
NSString *End_user_phone_number_validation = [jResp StringOf: @"settings.user.end_user_phone_number_validation"];
NSString *Have_gravatars_enabled = [jResp StringOf: @"settings.user.have_gravatars_enabled"];
NSString *Language_selection = [jResp StringOf: @"settings.user.language_selection"];
NSString *Multiple_organizations = [jResp StringOf: @"settings.user.multiple_organizations"];
NSString *UserTagging = [jResp StringOf: @"settings.user.tagging"];
NSString *Time_zone_selection = [jResp StringOf: @"settings.user.time_zone_selection"];
NSString *Agent_confirmation_when_forwarding = [jResp StringOf: @"settings.voice.agent_confirmation_when_forwarding"];
NSString *Agent_wrap_up_after_calls = [jResp StringOf: @"settings.voice.agent_wrap_up_after_calls"];
NSString *VoiceEnabled = [jResp StringOf: @"settings.voice.enabled"];
NSString *Logging = [jResp StringOf: @"settings.voice.logging"];
NSString *Maximum_queue_size = [jResp StringOf: @"settings.voice.maximum_queue_size"];
NSString *Maximum_queue_wait_time = [jResp StringOf: @"settings.voice.maximum_queue_wait_time"];
NSString *Only_during_business_hours = [jResp StringOf: @"settings.voice.only_during_business_hours"];
NSString *Outbound_enabled = [jResp StringOf: @"settings.voice.outbound_enabled"];
NSString *Recordings_public = [jResp StringOf: @"settings.voice.recordings_public"];
NSString *Uk_mobile_forwarding = [jResp StringOf: @"settings.voice.uk_mobile_forwarding"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"settings.cdn.hosts"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
strVal = [jResp StringOf: @"settings.localization.locale_ids[i]"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"settings.rule.skill_based_filtered_views"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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}"
}
]
}
