get https://bolt.thena.ai/v3/accounts//settings
This is the API to update settings at an account (channel) level. Pass `accountId` as the path parameter.
The `update` field accepts the fields that need to be updated.
The reset
field accepts an array of flattened configuration keys to be unset/removed.
Response parameters
Parameter | Description |
---|---|
error | Indicates if there is an error in the response. |
ok | Indicates if the request was successful. |
data[].relationship_id | The unique identifier for the relationship. |
data[].features.ma.config.disableTrackingPixel | Indicates if the tracking pixel is disabled in marketing automation. |
data[].features.requests.automations.makeThenaBotAutoJoinChannels.conditions.condition | Condition for auto-joining channels (e.g., starts with 'ext-'). |
data[].features.requests.automations.makeThenaBotAutoJoinChannels.isEnabled | Indicates if ThenaBot auto-joins channels based on the conditions. |
data[].features.requests.automations.notifyOnChannelJoin.conditions.condition | Condition for notifying when joining channels (e.g., starts with 'ext-'). |
data[].features.requests.automations.notifyOnChannelJoin.isEnabled | Indicates if notifications are sent when a channel is joined. |
data[].features.requests.automations.notifyOnChannelJoin.howAreChannelsDefined | Defines how channels are identified (e.g., 'by-conditions'). |
data[].features.requests.automations.notifyOnChannelJoin.channelIds | List of specific channel IDs for notifications when joining channels. |
data[].features.requests.automations.notifyOnChannelJoin.alertsChannel | The channel where alerts are sent when a channel is joined. |
data[].features.requests.config.show_user_emails_in_assignee | Indicates if user emails should be shown in the assignee field. |
data[].features.requests.config.ai_assist_auto_responder | Indicates if AI assist should auto-respond to requests. |
data[].features.requests.config.welcome_message | The welcome message to be sent to users joining the workspace. |
data[].features.requests.config.should_send_welcome_message | Indicates if the welcome message should be sent. |
data[].features.requests.config.block_request_detection | Indicates if request detection is blocked. |
data[].features.requests.config.send_suggestedrequest_message | Indicates if suggested request messages are sent. |
data[].features.requests.config.send_suggestedrequest_message_channel | The channel where suggested request messages are sent. |
data[].features.requests.config.conversation_grouping_window | The time window (in minutes) for grouping conversations. |
data[].features.requests.config.reopen_closed_requests | Indicates if closed requests should be reopened. |
data[].features.requests.config.move_onhold_to_inprogress | Indicates if requests on hold should be moved to in-progress. |
data[].features.requests.config.delete_notification_from_triage_in_minutes | Time (in minutes) before notifications are deleted from triage. |
data[].features.requests.config.suppress_requests_on_non_closed_conversation_threads | Suppresses requests on non-closed conversation threads. |
data[].features.requests.config.suppress_requests_on_non_closed_ticket_threads | Suppresses requests on non-closed ticket threads. |
data[].features.requests.config.use_customer_name_in_notifications | Indicates if the customer name should be used in notifications. |
data[].features.requests.config.use_customer_logo_in_notifications | Indicates if the customer logo should be used in notifications. |
data[].features.requests.config.auto_assign_request_to_first_responder | Automatically assigns requests to the first responder. |
data[].features.requests.config.send_assigned_to_notification_to_user | Sends notifications to the user when they are assigned a request. |
data[].features.requests.config.send_auto_assigned_ephemeral | Sends ephemeral messages when requests are auto-assigned. |
data[].features.requests.config.close_nudge_duration_in_minutes | Time (in minutes) for sending nudges to close requests. |
data[].features.requests.config.stop_nudge_for_triage_channel | Indicates if nudges are stopped for the triage channel. |
data[].features.requests.config.auto_close_duration_in_minutes | Time (in minutes) after which requests are automatically closed. |
data[].features.requests.config.auto_assign_thread_only | Indicates if only threads should be auto-assigned. |
data[].features.requests.config.send_status_updates_on_request_thread | Sends status updates in the request thread. |
data[].features.requests.config.send_first_request_notification | Sends notifications when the first request is detected. |
data[].features.requests.config.write_all_requests_to_crm | Writes all requests to the CRM. |
data[].features.requests.config.add_emojis_on_request_thread | Adds emojis to the request thread. |
data[].features.requests.config.send_request_detected_ephemeral_to_csm | Sends ephemeral messages to the CSM when a request is detected. |
data[].features.requests.config.auto_assign_to_csm | Automatically assigns requests to the customer success manager (CSM). |
data[].features.requests.config.store_non_suggested_request | Stores non-suggested requests. |
data[].features.requests.config.show_private_message_previews | Shows previews of private messages. |
data[].features.requests.config.appHomeOwnerFilters | Enables filters in the app home for request owners. |
data[].features.requests.config.send_feedback | Sends feedback messages for requests. |
data[].features.requests.config.send_feedback_as_ephemeral | Sends feedback messages as ephemeral. |
data[].features.requests.config.feedback_message | The feedback message sent when a request is closed. |
data[].features.requests.config.feedback_rating | The rating system for feedback (e.g., '2_POINTS'). |
data[].features.requests.config.send_request_feedback_received_message | Sends a message when request feedback is received. |
data[].features.requests.config.send_request_feedback_received_message_channel | The channel where feedback received messages are sent. |
data[].features.requests.config.request_for_text_feedback | Requests textual feedback from customers. |
data[].features.requests.config.knowledge_base_name | The name of the knowledge base. |
data[].features.requests.config.knowledge_base_url | The URL of the knowledge base. |
data[].features.requests.config.send_kbsuggested_answers | Sends suggested answers from the knowledge base. |
data[].features.requests.config.auto_create_ticket_from_request | Automatically creates tickets from requests. |
data[].features.requests.config.auto_respond_to_requests | Automatically responds to detected requests. |
data[].features.requests.config.message_for_auto_respond_to_requests | The message sent when auto-responding to a request. |
data[].features.requests.config.use_csm_avatar_for_auto_respond_to_requests | Uses the CSM's avatar for auto-responses. |
data[].features.requests.config.white_listed_bots | List of bots that are whitelisted for requests. |
data[].features.requests.config.is_request_escalation_enabled | Indicates if request escalation is enabled. |
data[].features.requests.config.message_for_request_escalation | The message sent for request escalation. |
data[].features.requests.config.block_new_request_creation_on_discard_request | Blocks new request creation when a request is discarded. |
data[].features.requests.config.host_domain | The host domain for the requests. |
data[].features.requests.config.web_request_redirection_channel | The channel to which web requests are redirected. |
data[].features.requests.config.web_request_email_communication | Indicates if web requests trigger email communication. |
data[].features.requests.config.ai_smart_grouping | Enables AI smart grouping of requests. |
data[].features.requests.config.send_request_escalation_message_channel | The channel to which escalation messages are sent. |
data[].features.requests.support.request_closure_sla.isEnabled | Indicates if the request closure SLA is enabled. |
data[].features.requests.support.request_closure_sla.sla | The SLA duration for request closure. |
data[].features.requests.support.request_closure_sla.sla_channel | The channel to which SLA breach notifications are sent. |
data[].features.requests.support.response_sla.workingHoursConfig.dailyConfigurations | Daily configurations for working hours. |
data[].features.requests.support.response_sla.workingHoursConfig.dailyWorkingHourConfig | Indicates if daily working hour configurations are enabled. |
data[].features.requests.support.response_sla.workingHoursConfig.holidayDates | List of holiday dates for working hours. |
data[].features.requests.support.response_sla.workingHoursConfig.workingDays | List of working days (by day number). |
data[].features.requests.support.response_sla.workingHoursConfig.timezone | Timezone for the working hours configuration. |
data[].features.requests.support.response_sla.workingHoursConfig.isEnabled | Indicates if the working hours configuration is enabled. |
data[].features.requests.support.response_sla.workingHoursConfig.sendOutOfOfficeAutoReply | Sends an out-of-office auto-reply during non-working hours. |
data[].features.requests.support.response_sla.workingHoursConfig.outOfOfficeAutoReplyMessage | The message sent as the out-of-office auto-reply. |
data[].features.requests.support.response_sla.workingHoursConfig.useCsmAvatarForAutoReply | Uses the CSM's avatar for the out-of-office auto-reply. |
data[].features.requests.support.response_sla.workingHoursConfig.outOfOfficeAutoReplyGroupingWindow | Time window (in hours) for grouping out-of-office auto-replies. |
data[].features.requests.support.response_sla.sla_breach_config.reaction.isEnabled | Indicates if reactions are enabled for SLA breaches. |
data[].features.requests.support.response_sla.sla_breach_config.reaction.message_ts_comparison | The condition for comparing message timestamps for SLA breaches. |
data[].features.requests.support.response_sla.sla_breach_config.conversation_response.isEnabled | Indicates if conversation response is enabled for SLA breaches. |
data[].features.requests.support.response_sla.sla_breach_config.suggested_request_invalidation.isEnabled | Indicates if request invalidation is enabled for SLA breaches. |
data[].features.requests.support.response_sla.sla_breach_config.request.isEnabled | Indicates if SLA breaches trigger request-level actions. |
data[].features.requests.support.response_sla.isEnabled | Indicates if response SLA is enabled. |
data[].features.requests.support.response_sla.sla | The SLA duration for response times. |
data[].features.requests.support.response_sla.sla_channel | The channel to which response SLA breach notifications are sent. |
data[].features.requests.support.severity.name | The name of the severity level (e.g., 'High', 'Medium', 'Low'). |
data[].features.requests.support.severity.value | The value of the severity level (e.g., 'High', 'Medium', 'Low'). |
data[].features.requests.support.tags.name | The name of a tag for classifying requests (e.g., 'Customer Onboarding'). |
data[].features.requests.support.tags.value | The value of a tag for classifying requests. |
data[].features.requests.ai.requestSubTypes | List of request subtypes for AI tagging. |
data[].features.requests.aiTags.userDefinedTags | List of user-defined AI tags. |
data[].features.requests.aiTags.blacklistedAITags | List of blacklisted AI tags (e.g., 'assistance', 'issue'). |
data[].features.requests.categories.category_name | The name of the category for classifying requests. |
data[].features.requests.categories.type | The type of the category (e.g., 'text', 'select'). |
data[].features.requests.categories.available_values.name | The name of an available value for the category. |
data[].features.requests.categories.available_values.value | The value of an available value for the category. |
data[].features.requests.categories.capture_change | Indicates if category changes are captured. |
data[].features.requests.categories.mandatory_on_close | Indicates if the category is mandatory on closing a request. |
data[].features.requests.categories.autoassign_by_ai | Indicates if the category is auto-assigned by AI. |
data[].features.requests.custom_fields.custom_field_id | The unique identifier for the custom field. |
data[].features.requests.custom_fields._id | The internal ID of the custom field. |
data[].features.requests.sink.salesforce | Salesforce ID for syncing requests with Salesforce. |
data[].features.requests.sink.salesforceAccountName | The name of the Salesforce account for syncing. |
data[].features.tickets.config.helpdeskIds | List of helpdesk IDs for the ticketing system. |
data[].features.tickets.config.formIds | List of form IDs for the ticketing system. |
data[].features.tickets.config.showOverflowMenu | Indicates if the overflow menu is shown in the ticketing system. |
data[].features.tickets.config.enable_only_for_customers_to_non_closed_ticket | Enables ticketing features only for customers with non-closed tickets. |
data[].features.tickets.config.change_stage_for_non_closed_ticket | Changes the stage for non-closed tickets. |
data[].features.tickets.config.change_stage_for_non_closed_ticket_to_value | The stage value for non-closed tickets. |
data[].features.tickets.config.change_stage_for_closed_ticket | Changes the stage for closed tickets. |
data[].features.tickets.config.change_stage_for_closed_ticket_to_value | The stage value for closed tickets. |
data[].features.tickets.config.enable_follow_up_ticket | Enables the creation of follow-up tickets. |
data[].features.tickets.config.map_submitter_to_requestor | Maps the submitter of a ticket to the requestor. |
data[].features.tickets.config.invisible_only | Indicates if tickets should only be visible to certain users. |
data[].features.tickets.config.send_invisible_ticket_feedback_message | Sends feedback messages for invisible tickets. |
data[].features.tickets.config.send_feedback_message | Sends feedback messages when tickets are closed. |
data[].features.tickets.config.feedback_message | The feedback message sent when a ticket is closed. |
data[].features.tickets.config.feedback_rating | The rating system for feedback on tickets (e.g., '2_POINTS'). |
data[].features.tickets.config.overflow_options | Options for the overflow menu in the ticketing system. |
data[].features.tickets.config.hide_tags | Indicates if tags are hidden in the ticketing system. |
data[].features.tickets.config.hide_urgency | Indicates if urgency levels are hidden in the ticketing system. |
data[].features.tickets.config.feedback_channel_id | The channel where feedback messages are sent for tickets. |
data[].features.tickets.config.send_feedback_as_ephemeral | Sends feedback messages as ephemeral in the ticketing system. |
data[].features.tickets.config.send_ai_summary_to_connectors | Sends AI-generated summaries to external connectors. |
data[].features.tickets.config.send_threads_to_connectors | Sends ticket threads to external connectors. |
data[].features.tickets.config.send_feedback_message_to_channel | Sends feedback messages to a specific channel. |
data[].features.tickets.config.do_not_show_ticket_modal | Disables the display of the ticket creation modal. |
data[].features.tickets.config.hide_priority | Indicates if the priority field is hidden in the ticketing system. |
data[].features.tickets.config.hide_request_type | Indicates if the request type is hidden in the ticketing system. |
data[].features.tickets.config.escalation_cool_off_period_in_min | The cool-off period (in minutes) before ticket escalations can occur. |
data[].features.tickets.config.reply_on_closure | Sends a reply when a ticket is closed. |
data[].features.tickets.config.reply_on_closure_message | The message sent when a ticket is closed. |
data[].features.tickets.config.allow_ticket_creation_with_ticket_emoji | Allows ticket creation using a ticket emoji. |
data[].features.internal_ticket.types.name | The name of the internal ticket type (e.g., 'Engineering'). |
data[].features.internal_ticket.types.value | The value of the internal ticket type (e.g., 'Engineering'). |
data[].features.internal_ticket.tags.name | The name of a tag for internal tickets (e.g., 'Customer Onboarding'). |
data[].features.internal_ticket.tags.value | The value of a tag for internal tickets. |
data[].features.internal_ticket.severity.name | The name of the severity level for internal tickets (e.g., 'High'). |
data[].features.internal_ticket.severity.value | The value of the severity level for internal tickets (e.g., 'High'). |
data[].features.internal_ticket.additionalFields | Additional fields for internal tickets. |
data[].features.internal_ticket.ticket_type_channels.Product | The Slack channel associated with the 'Product' ticket type. |
data[].features.crm.internal_channels.auto_sync | Indicates if internal CRM channels are automatically synced. |
data[].features.crm.internal_channels.pattern | The pattern used for creating internal CRM channels. |
data[].features.crm.summariser.schedule | The schedule for summarizing CRM data (e.g., 'DAILY'). |
data[].features.crm.summariser.timezone | The timezone used for CRM summarization. |
data[].features.crm.additional_fields | Additional fields related to the CRM integration. |
data[].features.crm.field_mappings | Mappings of fields between CRM and internal systems. |
data[].features.crm.type | The type of CRM integration (e.g., 'SALESFORCE'). |
data[].features.csat_send_for | Indicates which entities receive CSAT feedback (e.g., 'TICKET'). |
data[].features.hidePrivateChannelMetadata | Indicates if private channel metadata should be hidden. |
data[].features.emailToSlack.domains.name | The name of the domain for email-to-Slack communication. |
data[].features.emailToSlack.domains.require_tls | Indicates if TLS is required for the domain. |
data[].features.emailToSlack.domains.skip_verification | Indicates if verification is skipped for the domain. |
data[].features.emailToSlack.domains.state | The state of the domain (e.g., 'active'). |
data[].features.emailToSlack.domains.wildcard | Indicates if the domain is a wildcard domain. |
data[].features.emailToSlack.domains.spam_action | Action taken for spam messages on the domain (e.g., 'disabled'). |
data[].features.emailToSlack.domains.created_at | The timestamp when the domain was created. |
data[].features.emailToSlack.domains.smtp_password | The SMTP password for the domain. |
data[].features.emailToSlack.domains.smtp_login | The SMTP login for the domain. |
data[].features.emailToSlack.domains.type | The type of domain (e.g., 'custom'). |
data[].features.emailToSlack.domains.receiving_dns_records.is_active | Indicates if the DNS record for receiving emails is active. |
data[].features.emailToSlack.domains.receiving_dns_records.cached | Cached DNS records for receiving emails. |
data[].features.emailToSlack.domains.receiving_dns_records.priority | Priority for the DNS record (e.g., '10'). |
data[].features.emailToSlack.domains.receiving_dns_records.record_type | The type of DNS record (e.g., 'MX'). |
data[].features.emailToSlack.domains.receiving_dns_records.valid | Indicates if the DNS record is valid. |
data[].features.emailToSlack.domains.receiving_dns_records.value | The value of the DNS record (e.g., 'mxa.mailgun.org'). |
data[].features.emailToSlack.domains.sending_dns_records.is_active | Indicates if the DNS record for sending emails is active. |
data[].features.emailToSlack.domains.sending_dns_records.cached | Cached DNS records for sending emails. |
data[].features.emailToSlack.domains.sending_dns_records.name | Name of the DNS record for sending emails. |
data[].features.emailToSlack.domains.sending_dns_records.record_type | The type of DNS record for sending emails (e.g., 'TXT'). |
data[].features.emailToSlack.domains.sending_dns_records.valid | Indicates if the DNS record for sending emails is valid. |
data[].features.emailToSlack.domains.sending_dns_records.value | The value of the DNS record for sending emails. |
data[].features.emailToSlack.mappings.email | The email address used for email-to-Slack mapping. |
data[].features.emailToSlack.mappings.customEmail | The custom email address used for email-to-Slack mapping. |
data[].features.emailToSlack.mappings.channelId | The Slack channel ID for the email-to-Slack mapping. |
data[].features.emailToSlack.mappings.name | The name of the email-to-Slack mapping. |
data[].features.emailToSlack.mappings.description | Description of the email-to-Slack mapping. |
data[].features.emailToSlack.mappings.dnsVerified | Indicates if DNS verification is completed for the mapping. |
data[].features.emailToSlack.mappings.emailForwardingVerified | Indicates if email forwarding is verified for the mapping. |
data[].features.emailToSlack.mappings.emailReceivingVerified | Indicates if email receiving is verified for the mapping. |
data[].features.emailToSlack.mappings.deliveredWebhookCreatedAt | Timestamp when the webhook for delivered emails was created. |
data[].features.emailToSlack.mappings.failureWebhookCreatedAt | Timestamp when the webhook for failed emails was created. |
data[].features.emailToSlack.mappings.emailBlockingEnabled | Indicates if email blocking is enabled for the mapping. |