This is the API to fetch settings at a global (workspace) level.

Response parameters

ParameterDescription
errorIndicates if there is an error.
okIndicates if the request was successful.
ai.request_detection_strategyStrategy for detecting requests (e.g., Conservative).
features.ma.config.disableTrackingPixelWhether to disable the tracking pixel for messages.
features.requests.automations.makeThenaBotAutoJoinChannels.isEnabledEnables or disables Thena Bot auto-joining channels.
features.requests.automations.makeThenaBotAutoJoinChannels.conditions.conditionCondition for Thena Bot auto-joining channels.
features.requests.automations.makeThenaBotAutoJoinChannels.conditions.valueValue used to match the condition for Thena Bot auto-joining channels.
features.requests.automations.notifyOnChannelJoin.isEnabledEnables or disables notifications when a user joins a channel.
features.requests.automations.notifyOnChannelJoin.conditions.conditionCondition for channel join notifications.
features.requests.automations.notifyOnChannelJoin.conditions.valueValue used to match the condition for channel join notifications.
features.requests.automations.notifyOnChannelJoin.howAreChannelsDefinedHow channels are defined for notifications (e.g., byChannelId).
features.requests.automations.notifyOnChannelJoin.channelIdsList of channel IDs for join notifications.
features.requests.automations.notifyOnChannelJoin.alertsChannelThe Slack channel for sending alerts when users join a channel.
features.requests.automations.notifyOnChannelLeft.isEnabledEnables or disables notifications when a user leaves a channel.
features.requests.automations.notifyOnChannelLeft.conditions.conditionCondition for channel leave notifications.
features.requests.automations.notifyOnChannelLeft.conditions.valueValue used to match the condition for channel leave notifications.
features.requests.automations.notifyOnChannelLeft.howAreChannelsDefinedHow channels are defined for notifications (e.g., byChannelId).
features.requests.automations.notifyOnChannelLeft.channelIdsList of channel IDs for leave notifications.
features.requests.automations.notifyOnChannelLeft.alertsChannelThe Slack channel for sending alerts when users leave a channel.
features.requests.config.ai_assist_auto_responderEnables or disables AI auto-responders for requests.
features.requests.config.welcome_messageWelcome message displayed to users when they join.
features.requests.config.should_send_welcome_messageWhether or not to send the welcome message.
features.requests.config.block_request_detectionBlocks the detection of new requests.
features.requests.config.send_suggestedrequest_messageSends a suggested request message.
features.requests.config.send_suggestedrequest_message_channelThe Slack channel for sending suggested request messages.
features.requests.config.conversation_grouping_windowTime window (in minutes) for conversation grouping.
features.requests.config.reopen_closed_requestsAutomatically reopens closed requests.
features.requests.config.move_onhold_to_inprogressAutomatically moves requests from 'On Hold' to 'In Progress'.
features.requests.config.delete_notification_from_triage_in_minutesTime in minutes after which triage notifications are deleted.
features.requests.config.suppress_requests_on_non_closed_conversation_threadsSuppresses requests on non-closed conversation threads.
features.requests.config.suppress_requests_on_non_closed_ticket_threadsSuppresses requests on non-closed ticket threads.
features.requests.config.use_customer_name_in_notificationsUses customer name in notifications.
features.requests.config.use_customer_logo_in_notificationsUses customer logo in notifications.
features.requests.config.auto_assign_request_to_first_responderAutomatically assigns requests to the first responder.
features.requests.config.send_assigned_to_notification_to_userSends a notification when a user is assigned to a request.
features.requests.config.send_auto_assigned_ephemeralSends ephemeral messages for auto-assigned requests.
features.requests.config.close_nudge_duration_in_minutesDuration in minutes before sending a close nudge.
features.requests.config.stop_nudge_for_triage_channelStops sending nudge messages for the triage channel.
features.requests.config.auto_close_duration_in_minutesDuration in minutes before automatically closing requests.
features.requests.config.auto_assign_thread_onlyAuto-assigns threads only.
features.requests.config.send_status_updates_on_request_threadSends status updates on the request thread.
features.requests.config.send_first_request_notificationSends a notification when the first request is detected.
features.requests.config.write_all_requests_to_crmWrites all requests to the CRM.
features.requests.config.add_emojis_on_request_threadAdds emojis to the request thread.
features.requests.config.send_request_detected_ephemeral_to_csmSends ephemeral messages to CSM for detected requests.
features.requests.config.auto_assign_to_csmAutomatically assigns requests to the Customer Success Manager (CSM).
features.requests.config.store_non_suggested_requestStores non-suggested requests.
features.requests.config.show_private_message_previewsShows private message previews in the request thread.
features.requests.config.appHomeOwnerFiltersEnables filters for the app home owner.
features.requests.config.send_feedbackEnables or disables feedback requests.
features.requests.config.send_feedback_as_ephemeralSends feedback requests as ephemeral messages.
features.requests.config.feedback_messageFeedback message displayed to users after closing a request.
features.requests.config.feedback_ratingRating system for feedback (e.g., '2_POINTS').
features.requests.config.send_request_feedback_received_messageEnables or disables feedback received messages.
features.requests.config.send_request_feedback_received_message_channelChannel for feedback received messages.
features.requests.config.request_for_text_feedbackRequests textual feedback from users.
features.requests.config.knowledge_base_nameName of the knowledge base.
features.requests.config.knowledge_base_urlURL of the knowledge base.
features.requests.config.send_kbsuggested_answersSends suggested answers from the knowledge base.
features.requests.config.auto_create_ticket_from_requestAutomatically creates a ticket from a request.
features.requests.config.auto_respond_to_requestsAutomatically responds to detected requests.
features.requests.config.message_for_auto_respond_to_requestsMessage displayed for auto-responses to requests.
features.requests.config.use_csm_avatar_for_auto_respond_to_requestsUses the CSM's avatar for auto responses.
features.requests.config.white_listed_botsList of white-listed bots.
features.requests.config.is_request_escalation_enabledEnables or disables request escalation.
features.requests.config.message_for_request_escalationMessage displayed when escalating a request.
features.requests.config.block_new_request_creation_on_discard_requestBlocks the creation of new requests if a request is discarded.
features.requests.config.host_domainThe host domain for the requests.
features.support.request_closure_sla.isEnabledEnables or disables SLA for request closure.
features.support.request_closure_sla.slaTime in hours for request closure SLA.
features.support.response_sla.workingHoursConfig.dailyWorkingHourConfigEnables or disables daily working hour configuration.
features.support.response_sla.workingHoursConfig.holidayDatesList of holiday dates.
features.support.response_sla.workingHoursConfig.workingDaysList of working days.
features.support.response_sla.workingHoursConfig.timezoneTimezone for the working hours configuration.
features.support.response_sla.workingHoursConfig.isEnabledEnables or disables the working hours configuration.
features.support.response_sla.workingHoursConfig.sendOutOfOfficeAutoReplyEnables or disables automatic out-of-office replies.
features.support.response_sla.workingHoursConfig.outOfOfficeAutoReplyMessageMessage for out-of-office replies.
features.support.response_sla.workingHoursConfig.sendAutoReplyonAllCustomerMessagesSends automatic replies to all customer messages when out of office.
features.support.response_sla.workingHoursConfig.useCsmAvatarForAutoReplyUses the CSM's avatar for out-of-office auto replies.
features.support.response_sla.workingHoursConfig.lastOutOfOfficeAutoReplyTimeLast time an out-of-office auto reply was sent.
features.support.response_sla.workingHoursConfig.outOfOfficeAutoReplyGroupingWindowTime window (in hours) for grouping out-of-office auto replies.
features.support.response_sla.sla_breach_config.reaction.isEnabledEnables or disables reactions for SLA breaches.
features.support.response_sla.sla_breach_config.reaction.message_ts_comparisonTimestamp comparison method for SLA breach reactions.
features.support.response_sla.sla_breach_config.conversation_response.isEnabledEnables or disables conversation response for SLA breaches.
features.support.response_sla.sla_breach_config.conversation_response.modeMode for conversation response (e.g., channel).
features.support.response_sla.sla_breach_config.conversation_response.message_ts_comparisonTimestamp comparison method for conversation response.
features.support.response_sla.sla_breach_config.suggested_request_invalidation.isEnabledEnables or disables invalidation of suggested requests.
features.support.response_sla.sla_breach_config.suggested_request_invalidation.message_ts_comparisonTimestamp comparison method for suggested request invalidation.
features.support.response_sla.sla_breach_config.request.isEnabledEnables or disables request-level SLA breach configurations.
features.support.response_sla.isEnabledEnables or disables SLA for responses.
features.support.response_sla.slaSLA time for response in hours.
ai.requestSubTypesList of request subtypes for AI handling.
aiTags.userDefinedTagsList of user-defined AI tags.
aiTags.blacklistedAITagsList of blacklisted AI tags (e.g., 'assistance', 'issue').
tickets.config.helpdeskIdsList of helpdesk IDs.
tickets.config.formIdsList of form IDs.
tickets.config.showOverflowMenuEnables or disables the overflow menu.
tickets.config.enable_only_for_customers_to_non_closed_ticketRestricts ticket handling to non-closed tickets for customers.
tickets.config.change_stage_for_non_closed_ticketAutomatically changes the stage for non-closed tickets.
tickets.config.change_stage_for_non_closed_ticket_to_valueThe value to change the stage to for non-closed tickets (e.g., 'open').
tickets.config.change_stage_for_closed_ticketAutomatically changes the stage for closed tickets.
tickets.config.change_stage_for_closed_ticket_to_valueThe value to change the stage to for closed tickets (e.g., 'open').
tickets.config.enable_follow_up_ticketEnables or disables follow-up tickets.
tickets.config.map_submitter_to_requestorMaps ticket submitter to requestor.
tickets.config.invisible_onlyEnables or disables invisible-only tickets.
tickets.config.send_invisible_ticket_feedback_messageSends feedback messages for invisible tickets.
tickets.config.send_feedback_messageEnables or disables feedback messages for tickets.
tickets.config.feedback_messageFeedback message displayed to users after closing a ticket.
tickets.config.feedback_ratingRating system for ticket feedback (e.g., '2_POINTS').
tickets.config.overflow_optionsList of overflow options for tickets.
tickets.config.hide_tagsHides tags in tickets.
tickets.config.hide_urgencyHides urgency levels in tickets.
tickets.config.feedback_channel_idChannel ID for ticket feedback.
tickets.config.send_feedback_as_ephemeralSends ticket feedback as ephemeral messages.
tickets.config.send_ai_summary_to_connectorsSends AI-generated summaries to connectors.
tickets.config.send_threads_to_connectorsSends ticket threads to connectors.
tickets.config.send_feedback_message_to_channelSends feedback messages to a specified channel.
tickets.config.do_not_show_ticket_modalPrevents displaying the ticket modal.
tickets.config.hide_priorityHides priority levels in tickets.
tickets.config.hide_request_typeHides request types in tickets.
tickets.config.escalation_cool_off_period_in_minCool-off period for ticket escalation in minutes.
tickets.config.reply_on_closureEnables or disables replies on ticket closure.
tickets.config.reply_on_closure_messageMessage displayed when replying to a closed ticket.
tickets.config.allow_ticket_creation_with_ticket_emojiEnables ticket creation using a specific ticket emoji.
Language
Authorization
Bearer
Click Try It! to start a request and see the response here!