--- title: "Get the current chat widget information (status, settings, etc.)" method: GET path: "/v1/chat/widget" tags: ["Chat"] --- # Get the current chat widget information (status, settings, etc.) `GET /v1/chat/widget` ## Query parameters - `apiKey` string - `url` string - `iosKey` string - `androidKey` string - `visitorId` string - `email` string - `phone` string - `userHash` string ## Response `200` OK - ChatModeResponse - `statusCode` integer, nullable - `success` boolean - `message` string, nullable - `resource` ChatModeModel - `status` integer — Durum 1: aktif, 0: pasif - `settings` ChatWidgetModelPublic - `privateKey` string, nullable - `apiKey` string, nullable - `iosKey` string, nullable - `androidKey` string, nullable - `id` integer - `accountId` integer - `departmentId` integer - `name` string, required - `domain` string, required - `workingHourType` integer - `offlineMsg` string, nullable - `onlineMsg` string, nullable - `chatTitle` string, nullable - `chatSubtitle` string, nullable - `chatTitleOffline` string, nullable - `chatSubtitleOffline` string, nullable - `botLogo` string, nullable - `language` string, nullable - `status` boolean - `contactInfo` string, nullable - `messages` string, nullable - `showEmojiButton` boolean - `allowVisitorCloseChat` boolean - `showAttachmentButton` boolean - `showChatHistory` boolean - `otpEnabled` boolean - `otpEmailRawHtml` boolean - `mailId` integer - `removeBranding` boolean - `identityVerification` boolean - `primaryColor` string, nullable - `contactInfoEnabled` boolean - `integrations` string, nullable - `chatHomePage` ChatHomePage - `id` integer - `enabled` boolean - `logo` string, nullable - `title` string, nullable - `subtitle` string, nullable - `chatStarterTitle` string, nullable - `chatStarterSubtitle` string, nullable - `desk` string, nullable - `widgets` ChatHomepageWidget[], nullable - `component` string, nullable - `props` string, nullable - `desk` ChatDesk - `_id` string, nullable - `domain` string, nullable - `slug` string, nullable - `survey` Survey - `id` integer - `accountId` integer - `departmentId` integer - `name` string, nullable - `message` string, nullable - `linkedId` integer - `linkedTable` 0 | 1 | 2 | 5 | 6 | 7 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 21 | 22 | 23 | 25 | 26 | 27 | 31 | 32 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 50 | 51 | 52 | 53 | 55 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 72 — Infoset data objects

Enum values:

0 = None
1 = Company
2 = Contacts
5 = Deals
6 = EmailLogs
7 = Emails
10 = MailAccounts
11 = MarketingLog
12 = MarketingSession
13 = MarketingTable
14 = Pipeline
15 = PipelineStages
16 = Todos
19 = TicketLogs
20 = Tickets
21 = Users
22 = Settings
23 = ContactGroups
25 = UserRights
26 = CustomUserRights
27 = UserGroups
31 = Automations
32 = Subjects
34 = Categories
35 = CallLogs
36 = Voicemails
37 = UserChannelRights
38 = CallCenterQueues
39 = DialPlans
40 = ServiceProviders
41 = IvrMenus
42 = IvrMenuDetails
43 = IvrPlugins
44 = VoipUsers
45 = DialerTable
46 = DialerSession
47 = DialerSessionLog
48 = DialerDtmfLink
50 = ChatRooms
51 = ChatTable
52 = ChatMessages
53 = ChatWidgets
55 = OutboundMessages
60 = ChatWidgetHomepage
61 = Chatbot
62 = ChatbotObject
63 = DealLogs
64 = SlaPolicies
65 = Sms
66 = Survey
67 = Announcements
68 = AnnouncementReadLogs
69 = AuditLogs
72 = Integrations

- `type` 1 | 2 | 3 —

Enum values:

1 = Survey
2 = Nps
3 = Csat

- `inputType` 1 | 2 —

Enum values:

1 = Text
2 = Sound

- `options` string, nullable - `sipServerId` integer - `createdDate` string, date-time - `links` SurveyLink[], nullable - `id` integer - `linkedId` integer - `linkedTable` 0 | 1 | 2 | 5 | 6 | 7 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 21 | 22 | 23 | 25 | 26 | 27 | 31 | 32 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 50 | 51 | 52 | 53 | 55 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 72 — Infoset data objects

Enum values:

0 = None
1 = Company
2 = Contacts
5 = Deals
6 = EmailLogs
7 = Emails
10 = MailAccounts
11 = MarketingLog
12 = MarketingSession
13 = MarketingTable
14 = Pipeline
15 = PipelineStages
16 = Todos
19 = TicketLogs
20 = Tickets
21 = Users
22 = Settings
23 = ContactGroups
25 = UserRights
26 = CustomUserRights
27 = UserGroups
31 = Automations
32 = Subjects
34 = Categories
35 = CallLogs
36 = Voicemails
37 = UserChannelRights
38 = CallCenterQueues
39 = DialPlans
40 = ServiceProviders
41 = IvrMenus
42 = IvrMenuDetails
43 = IvrPlugins
44 = VoipUsers
45 = DialerTable
46 = DialerSession
47 = DialerSessionLog
48 = DialerDtmfLink
50 = ChatRooms
51 = ChatTable
52 = ChatMessages
53 = ChatWidgets
55 = OutboundMessages
60 = ChatWidgetHomepage
61 = Chatbot
62 = ChatbotObject
63 = DealLogs
64 = SlaPolicies
65 = Sms
66 = Survey
67 = Announcements
68 = AnnouncementReadLogs
69 = AuditLogs
72 = Integrations

- `triggers` OutboundMessage[], nullable - `data` OutboundMessageData, required - `id` integer - `departmentId` integer - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, required —

Enum values:

1 = Chat
2 = Post
3 = Email
4 = Chatbot
5 = ProductTour
6 = Banner
7 = MobilePush
8 = MobileCarousel
9 = SocialMedia
10 = Sms

- `name` string, required - `message` string, nullable - `runCount` integer - `workingHourType` integer — Çalışma Saatleri Seçeneği 0:Yok, 1: Sistem Ayarları Mesai Saati Kullan, 2: Özel Mesai Saati Kullan, 3:Mesai saatleri dışı, 4:Agentlar aktif olduğunda aktif - `sendType` 1 | 2 —

Enum values:

1 = Ongoing
2 = OneOff

- `status` integer — 0 inactive, 1 active - `settings` unknown - `startTime` string, date-time, nullable - `endTime` string, date-time, nullable - `createdAt` string, date-time, nullable - `updatedAt` string, date-time, nullable - `lastRunAt` string, date-time, nullable - `filters` OutboundMessageFilter[], required - `id` integer - `messageId` integer - `filterType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 —

Enum values:

0 = VisitPage
1 = TimeOnPage
2 = NVisitsOnPage
3 = VisitOnDate
4 = VisinOnDatetime
5 = VisitFromUrl
6 = VisitFromLocation
7 = ContactFilter
8 = CompanyFilter
9 = Device

- `filterColumn` string, nullable - `filterValue` string, nullable - `filterOperation` string, nullable - `filterPrefix` string, nullable - `chatbots` PublicChatbotModel[], nullable - `id` integer - `name` string, nullable - `avatar` string, nullable - `firstMessage` string, nullable - `publishedVersionId` integer - `workingHourType` integer - `departmentId` integer - `customFields` PublicChatCustomFieldModel[], nullable - `id` integer - `fieldName` string, nullable - `fieldType` string, nullable - `fieldOptions` string, nullable - `visitor` ChatVisitorDataItem - `id` string, nullable - `firstName` string, nullable - `lastName` string, nullable - `email` string, nullable - `phone` string, nullable - `photoUrl` string, nullable - `userHash` string, nullable — visitorId+chat widget private key sha256 - `createdAt` string, nullable — yyyy-MM-dd HH:mm:ss, UTC time - `customFields` string, nullable - `company` string, nullable - `statusCode` 0 | -3282 | -3281 | -3280 | -3279 | -3278 | -3277 | -3276 | -3275 | -3274 | -3273 | -3272 | -3271 | -3270 | -3269 | -3268 | -3267 | -3266 | -3265 | -3264 | -3263 | -3262 | -3261 | -3260 | -3259 | -3258 | -3257 | -3256 | -3255 | -3254 | -3253 | -3252 | -3251 | -3250 | -3249 | -3248 | -3247 | -3246 | -3245 | -3244 | -3243 | -3242 | -3241 | -3240 | -3239 | -3238 | -3237 | -3236 | -3235 | -3234 | -3233 | -3232 | -3231 | -3230 | -3229 | -3228 | -3227 | -3226 | -3225 | -3224 | -3223 | -3222 | -3221 | -3220 | -3219 | -3218 | -3217 | -3216 | -3215 | -3214 | -3213 | -3212 | -3211 | -3210 | -3202 | -3201 | -3200 | -3121 | -3120 | -3119 | -3118 | -3117 | -3116 | -3115 | -3114 | -3113 | -3112 | -3111 | -3110 | -3109 | -3108 | -3107 | -3106 | -3105 | -3104 | -3103 | -3102 | -3101 | -3012 | -3011 | -3010 | -3009 | -3008 | -3007 | -3006 | -3005 | -3004 | -3003 | -3001 | -3000 | -2954 | -2953 | -2952 | -2951 | -2950 | -2912 | -2911 | -2910 | -2909 | -2908 | -2907 | -2905 | -2904 | -2903 | -2902 | -2901 | -2900 | -2849 | -2848 | -2847 | -2846 | -2845 | -2844 | -2843 | -2842 | -2841 | -2840 | -2839 | -2838 | -2837 | -2836 | -2835 | -2834 | -2833 | -2832 | -2831 | -2830 | -2829 | -2828 | -2827 | -2826 | -2825 | -2824 | -2823 | -2822 | -2821 | -2820 | -2819 | -2818 | -2817 | -2816 | -2815 | -2814 | -2813 | -2812 | -2811 | -2810 | -2802 | -2801 | -2800 | -2702 | -2701 | -2700 | -2699 | -2698 | -2697 | -2696 | -2695 | -2694 | -2693 | -2692 | -2691 | -2690 | -2681 | -2680 | -2670 | -2660 | -2650 | -2640 | -2630 | -2620 | -2611 | -2610 | -2602 | -2601 | -2600 | -2500 | -2400 | -2300 | -2201 | -2200 | -2100 | -2002 | -2001 | -2000 | -1951 | -1950 | -1930 | -1926 | -1925 | -1924 | -1923 | -1922 | -1921 | -1920 | -1919 | -1918 | -1917 | -1916 | -1915 | -1914 | -1913 | -1912 | -1911 | -1910 | -1909 | -1908 | -1907 | -1906 | -1905 | -1904 | -1903 | -1902 | -1901 | -1900 | -1803 | -1802 | -1801 | -1203 | -1202 | -1201 | -1200 | -905 | -822 | -821 | -820 | -819 | -818 | -817 | -816 | -815 | -814 | -813 | -812 | -811 | -421 | -417 | -416 | -415 | -413 | -412 | -411 | -409 | -408 | -406 | -405 | -404 | -403 | -402 | -401 | -400 | -340 | -339 | -338 | -337 | -336 | -335 | -334 | -333 | -332 | -331 | -329 | -328 | -327 | -325 | -324 | -323 | -322 | -321 | -320 | -319 | -318 | -317 | -316 | -315 | -314 | -313 | -312 | -311 | -309 | -308 | -302 | -301 | -214 | -213 | -212 | -209 | -202 | -195 | -194 | -151 | -97 | -96 | -95 | -91 | -90 | -89 | -88 | -87 | -86 | -83 | -82 | -81 | -80 | -64 | -63 | -60 | -23 | -22 | -21 | -13 | -12 | -9 | -8 | -7 | -4 | -1 —

Enum values:

0 = Success - Success
-3282 = UserStateValueMissing - A user state change arrived without a state value (HTTP 400). Rejected rather than defaulted, because the enum's default is Passive and would take the operator off duty.
-3281 = GenAiResolveRoomUnreadable - A gen-ai resolve could not read or could not close the room (HTTP 503). Nothing was written — the ownership check happens before the close and the replay gate after it — so the room is in the state it started in and a retry has no side effects. It is a 5xx precisely so the caller retries: a 200 here would tell the assistant a conversation was resolved while it is still open, held by a bot that has already stopped watching it.
-3280 = GenAiResolveIdempotencyKeyRequired - A gen-ai resolve was called without an idempotency key (HTTP 400). Same reasoning as : the key is what makes the route safe for an at-least-once caller, and an empty one would silently disable the replay gate.
-3279 = GenAiHandoffRoomUnreadable - A gen-ai handoff released the room but could not re-read it, and the room still exists — so the read failed rather than the room being deleted (HTTP 503). Routing was NOT triggered and the replay gate was deliberately NOT written, which leaves the room released, unassigned and undispatched: taken from the assistant and handed to nobody. It is reported as a 5xx precisely because it is the one branch on this route that the caller MUST retry — a 200 here tells gen-ai the transfer succeeded, and gen-ai then publishes "I am connecting you with a colleague" and writes its seven-day silence key over a room no human will ever be dispatched to.
-3278 = GenAiHandoffIdempotencyKeyRequired - A gen-ai handoff was called without an idempotency key (HTTP 400). Rejected rather than tolerated: the key is what makes the endpoint safe for an at-least-once caller, and accepting an empty one would silently disable the replay gate — a failure with no symptom until a duplicate handoff re-armed a second SLA clock on the same conversation.
-3277 = GenAiOwnershipClaimInvalid - A gen-ai chat-ownership claim was called with a non-positive roomId or accountId (HTTP 400). Distinct from the brand and bot-identity failures above so the caller can tell "I addressed nothing" from "I have no brand" and "I have no identity"; the claim itself never reports contention this way, because losing a room to a human is a 200 with owned: false rather than an error.
-3276 = GenAiBotIdentityUnavailable - Enabling the gen-ai assistant could not establish the brand's AI bot identity (HTTP 500): the insert hit the unique constraint, and the re-read that should have returned the winning concurrent row found nothing. Reported rather than retried or papered over — a config row whose AI_BOT_ID is NULL leaves the runtime with no id to attribute messages to or claim rooms with, and it must never be minted twice.
-3275 = GenAiDepartmentRequired - A gen-ai-facing internal route was called with departmentId <= 0 or accountId <= 0 (HTTP 400). Shared by every gen-ai internal route — including the typing relay (P23) — so a gen-ai client can branch on a single value. Distinct from the gen-ai admin write path above, which reports 422 per field.
-3274 = GenAiConfigNoKnowledgeBase - An attempt to enable the gen-ai assistant for a brand whose resolved knowledge base is empty (HTTP 422) — the brand has no copilot row of its own, or that row selects no desks. An assistant with no knowledge base can only fabricate or hand off; one with another brand's knowledge base is worse.
-3273 = GenAiConfigDepartmentRequired - A gen-ai configuration write arrived without a brand, or with departmentId <= 0 (HTTP 422). There is no account-level gen-ai row, so a payload without a brand has no valid target.
-3272 = ChatbotObjectDepartmentForbidden - The user may not write chatbot objects for the target brand (HTTP 422).
-3271 = ChatbotDepartmentLockedByObject - Brand change refused because the flow calls functions that do not exist in the target brand, where the references would resolve to nothing (HTTP 422).
-3270 = ChatbotDepartmentLockedByChannel - Brand change refused because attached channel links would end up pointing at another brand's widget/integration (HTTP 422).
-3269 = WhatsappMarketingOptedOut - Distinguishes an explicit recipient opt-out from provider or integration failures so the client can present a non-retryable, category-specific error.
-3268 = ChatbotChannelConflictChanged - The channel ownership or schedule changed after the takeover confirmation was shown. The client must refresh the conflict and ask again (HTTP 409).
-3267 = ChatbotConnectionSecretVaultUnconfigured - The server has no CHATBOT_CONNECTION_ENCRYPTION_KEY configured, so chatbot connection secrets cannot be stored safely (HTTP 500).
-3266 = ChatbotStatusTransitionInvalid - The requested chatbot lifecycle transition is not valid from the bot's current status (e.g. unpublishing a draft, unarchiving a published bot) (HTTP 422).
-3265 = ChatbotConnectionInUse - The chatbot connection is still referenced by a bot flow (or a published version snapshot), so it cannot be deleted — deleting would leave those API call steps without credentials (HTTP 422).
-3264 = ChatbotChannelNotFound - The selected channel integration no longer exists (deleted, or the picker was fed a stale cache). Distinct from the brand mismatch: nothing to fix by switching brands (HTTP 422).
-3263 = ChatbotChannelTargetTaken - The selected channel target (widget/number/page/bot) is already linked to another chatbot — one target hosts exactly one bot (HTTP 422).
-3262 = ChatbotIntegrationDepartmentMismatch - The selected channel integration is missing, is not a WhatsApp number, or does not belong to the chatbot's submitted brand (HTTP 422).
-3261 = ChatbotChannelTypeNotSupported - The chatbot was linked to a channel type that cannot host a bot (HTTP 422).
-3260 = CustomReportFormulaInvalid - A custom report formula failed expression validation at save time (HTTP 400). The message names exactly what was rejected (IDT-1904).
-3259 = DynamicReportsAppNotInstalled - The dynamic reports (report builder) paid add-on is not installed on the account (HTTP 403).
-3258 = RequiredCustomFieldsEmpty - A ticket status/stage/pipeline change left one or more required fields empty (HTTP 422). The empty field names are returned in the response.
-3257 = UserGroupDepartmentMismatch - A user may only join a user group that serves at least one of the user's brands (HTTP 422).
-3256 = ChatbotWidgetDepartmentMismatch - The selected chat widget does not belong to the chatbot's submitted brand or account (HTTP 422).
-3255 = ChatbotDepartmentForbidden - A chatbot write targeted a brand outside the actor's department access (HTTP 422).
-3254 = ContactGroupDepartmentMismatch - A contact may only be added to a group of its own brand (HTTP 422).
-3253 = UserDepartmentForbidden - A user read or write targeted departments outside the actor's department access (HTTP 403).
-3252 = CallCenterDialPlanDepartmentMismatch - A dial rule targets a destination (queue/IVR/voip) belonging to a different brand (HTTP 422).
-3251 = CallCenterAgentDepartmentMismatch - A call-center queue was assigned an agent belonging to a different brand (HTTP 422).
-3250 = UserAvailabilityDepartmentForbidden - User availability was targeted outside the actor's authoritative department access (HTTP 403).
-3249 = InvalidDepartmentScope - The global department scope header is neither "all" nor a positive department id (HTTP 400).
-3248 = DealCompanyDepartmentMismatch - IDT-1375: a deal may only reference a company of its own brand (HTTP 422).
-3247 = DealContactDepartmentMismatch - IDT-1375: a deal may only reference a contact of its own brand (HTTP 422).
-3246 = TicketCompanyDepartmentMismatch - IDT-1375: a ticket may only reference a company of its own brand (HTTP 422).
-3245 = TicketContactDepartmentMismatch - IDT-1375: a ticket may only reference a contact of its own brand (HTTP 422).
-3244 = ContactCompanyDepartmentMismatch - IDT-1386: a contact may only be linked to a company of its own brand (HTTP 422).
-3243 = ContactMergeDepartmentMismatch - IDT-1390: contacts are single-brand — cards from different brands cannot be merged (HTTP 422).
-3242 = AudioFileDepartmentMismatch - IVR/queue references an audio file that belongs to a different department.
-3241 = AudioFileDepartmentNotAllowed - User is not allowed to assign the audio file to the requested department.
-3240 = AudioFileNameConflict - Audio file with the same name exists in a brand the user cannot modify, or upload tried to change an existing file's brand.
-3239 = OutboundMessageChatbotWidgetMismatch - The selected chatbot is not linked to the outbound message's chat widget (HTTP 422).
-3239 = OutboundMessageChatbotWidgetMismatch - The selected chatbot is not linked to the outbound message's chat widget (HTTP 422).
-3238 = IntegrationCapabilityDetailsReadFailed - Operational details for an accessible integration could not be loaded from its provider. HTTP 502.
-3238 = IntegrationCapabilityDetailsReadFailed - Operational details for an accessible integration could not be loaded from its provider. HTTP 502.
-3237 = IntegrationCapabilitiesReadFailed - The safe, tenant-scoped integration capability list could not be loaded. HTTP 500.
-3237 = IntegrationCapabilitiesReadFailed - The safe, tenant-scoped integration capability list could not be loaded. HTTP 500.
-3236 = OutboundMessageDepartmentRequired - An outbound message must name a brand on create (HTTP 422).
-3235 = DefaultDepartmentCannotBeDeleted - IDT-1345: the default department cannot be deleted; another department must be marked as default first (HTTP 422).
-3234 = MailAccountProcessDepartmentMismatch - A mail account selected a process, default process, or stage outside the mail account's brand (HTTP 422).
-3233 = DepartmentDeleted - The record's brand has been permanently deleted and the operation cannot be performed (HTTP 422).
-3232 = DepartmentPendingDeletion - The record's brand is pending deletion and must be restored before the operation can proceed (HTTP 422).
-3231 = CopilotConfigDeskFetchFailed - The helpdesk service could not be reached (or returned a non-success / undecodable response) while loading the account's desks for Copilot config desk-ownership validation. The PUT fails closed rather than persisting an unvalidated desk selection. HTTP 502.
-3230 = CopilotConfigDeskSelectionTooLarge - A Copilot config PUT's serialized SELECTED_DESK_IDS CSV exceeds the DB column limit (varchar(1024)). Rejected before the upsert so we never hit a DB truncation / strict-mode error. HTTP 422.
-3229 = CopilotConfigDeskDepartmentMismatch - A Copilot config PUT referenced a desk that does not exist on the account, or — for a department-scoped (DepartmentId > 0) config — a desk that belongs to a different brand than the config row. HTTP 422.
-3228 = TicketDepartmentForbidden - A ticket's AI data (sentiment/intents/customer-context/summary/suggestions) was requested by an agent not permitted to access the ticket's brand. HTTP 422.
-3227 = ChatDepartmentForbidden - A chat room's AI data (intents/sentiment/customer-context/suggestions) was requested by an agent not permitted to access the room's brand. HTTP 422.
-3226 = DepartmentNotDeleted - Restore was attempted, but the brand has not been deleted and is still active (HTTP 409).
-3225 = DepartmentNotInRecoveryWindow - Restore was attempted, but the 30-day recovery window has closed (finalized) or expired (HTTP 409).
-3224 = DepartmentReassignTargetInvalid - The reassignment target is invalid: it does not belong to the account / has been deleted / is the brand being deleted (HTTP 422).
-3223 = DepartmentReassignTargetRequired - Soft-delete was requested, but no target brand was specified to take over the open tickets/deals (HTTP 422).
-3222 = WorkingHourDepartmentRequired - System (account-default) working hours must name at least one brand (IDT-444). HTTP 422.
-3221 = BulkUserBrandInvalid - A bulk "change brand" action referenced a department that is not in the account (IDT-934). HTTP 422.
-3220 = BulkUserActionOwnerOnly - Bulk user actions are restricted to the account Owner (IDT-934). HTTP 403.
-3219 = AuditLogExportOwnerOnly - Audit log export is restricted to the account Owner (IDT-924). HTTP 403.
-3218 = ArticleNotFound - The requested KB article was not found (upstream helpdesk returned 404).
-3217 = ArticleNotVisible - The requested KB article is not visible to the current agent (brand or group filter).
-3216 = CallCenterDepartmentRequired
-3215 = DepartmentHasActiveChannels
-3214 = CallCenterDepartmentForbidden
-3213 = IntegrationDepartmentForbidden
-3212 = DepartmentNameConflict
-3211 = ChatWidgetDepartmentRequired
-3210 = MailAccountDepartmentRequired
-3202 = DealDepartmentRequired
-3201 = TicketDepartmentRequired
-3200 = PipelineDepartmentRequired
-3121 = GlobalAdminCannotAssignElevatedProfile - Global Admin cannot assign or remove the Owner / Global Admin profiles (IDT-1689). HTTP 403.
-3120 = ElevatedProfileCannotBeCloned - The Owner and Global Admin system profiles cannot be cloned (IDT-1318). HTTP 403.
-3119 = NonGrantableRightDenied - A custom profile tried to grant a non-grantable (⛔) right — see NonGrantableRights (IDT-1078, S4). HTTP 403.
-3118 = CustomProfileOwnerOnly - Only the account Owner may create (or clone) a custom profile (IDT-1078, S4). HTTP 403.
-3117 = BrandManagerCannotAssignOutsideBrand - Brand Manager cannot assign a profile to a user that belongs to a brand outside the manager's own. HTTP 403.
-3116 = BrandManagerCannotAssignElevatedProfile - Brand Manager cannot assign account-level profiles (Owner / Global Admin). HTTP 403.
-3115 = ProfileAssignmentNotAuthorized - Actor is not allowed to assign profiles (e.g. Global Admin, who cannot manage users). HTTP 403.
-3114 = CannotChangeOwnProfile - A user cannot change/elevate their own profile (self-elevation ban). HTTP 403.
-3113 = OwnerLimitReached - Account already has the maximum number of Owners (PermissionProfileService.MaxOwnerCount). HTTP 422.
-3112 = NotAuthorized
-3111 = UserAlreadyInProfile
-3110 = UserNotFoundInProfile
-3109 = NewProfileNameRequired
-3108 = SourceProfileNotFound
-3107 = ProfileDepartmentNotFound
-3106 = ProfileDepartmentRequired
-3105 = ProfileNameRequired
-3104 = SystemProfileRightsCannotBeModified
-3103 = SystemProfileCannotBeDeleted
-3102 = SystemProfileCannotBeModified
-3101 = ProfileNotFound
-3012 = RoutingAssignmentForbiddenDepartment
-3011 = RoutingQueueDepartmentRequired
-3010 = RoutingOfferSettingsInvalid
-3009 = RoutingQueueValidationError
-3008 = RoutingQueueNotFound
-3007 = RoutingServiceUnavailable
-3006 = RoutingAssignmentFailed
-3005 = RoutingInvalidResponseType
-3004 = RoutingOfferExpired
-3003 = RoutingOfferAlreadyResponded
-3001 = RoutingInvalidLinkedType
-3000 = RoutingItemNotFound
-2954 = CallServerMisconfigured - sip_servers row has no http_base_url configured, or target sip_server_id does not exist. Deploy/seed issue.
-2953 = CallServerUnavailable - CallServer is temporarily unavailable (5xx, network, timeout). Transient — retryable.
-2952 = CallServerNotFoundUpstream - CallServer reported the target resource (sip_server_id / sessionId / agent) not found (404).
-2951 = CallServerBadRequest - CallServer rejected the command as invalid (400). DTO contract drift or caller-supplied bad input.
-2950 = CallServerAuthFailure - CallServer rejected X-API-Key on an internal command endpoint (401). Deploy config issue.
-2912 = LiveMonitorNotImplemented
-2911 = InvalidEndCallRequest
-2910 = InvalidCancelDialRequest
-2909 = InvalidAddUpdateAccountRequest
-2908 = InvalidSetCallParamRequest
-2907 = AgentNotFound
-2905 = CallSessionNotFound
-2904 = NumberInvalid
-2903 = LineBusy
-2902 = InvalidTransferRequest
-2901 = InvalidDialDirectRequest
-2900 = InvalidDialRequest
-2849 = VoipGatewayProviderNotFound - No voip gateway provider matches the supplied id for the given account.
-2848 = InvalidGatewayRegisteredPayload - Required fields missing or invalid on PUT /v1/cs/voip-gateway-providers/{id}/registered.
-2847 = FeedbackInsertFailed - Feedback insert failed at the database layer (no rows written).
-2846 = InvalidFeedbackPayload - Required fields missing or invalid on POST /v1/cs/feedbacks.
-2845 = DialerTableNotFound - No dialer table record matches the supplied id for the given account (with PERIOD_TYPE=0).
-2844 = InvalidDialerTableStatus - Invalid status value on PUT /v1/cs/dialer-tables/{id}/status (allowed: 0).
-2843 = DialerSessionNotFound - No dialer session record matches the supplied id for the given account.
-2842 = InvalidDialerSessionStatus - Invalid status value on PUT /v1/cs/dialer-sessions/{id}/status (allowed: 1, 4).
-2841 = DialerSessionLogNotFound - No dialer session log record matches the supplied id for the given account.
-2840 = InvalidDialerSessionLogPayload - Required fields missing or invalid on PUT /v1/cs/dialer-session-logs/{id}.
-2839 = InvalidDialerSessionLogSearchRequest - Required fields missing or invalid on POST /v1/cs/dialer-session-logs/search.
-2838 = VoipUserNotFound
-2837 = InvalidAvailabilityPayload
-2836 = InvalidRedirectPayload
-2835 = MissingQueueId - Query string queueId missing or non-positive on GET /internal/queue-stats.
-2834 = InvalidCallLogRecordingRequest - Required fields missing or invalid on PUT /v1/cs/call-logs/{id}/recording.
-2833 = InvalidContactLastActivityRequest - Required fields missing or invalid on PUT /v1/cs/contacts/{id}/last-activity (at least one of lastSeen/lastHeard/lastContacted must be supplied).
-2832 = InvalidAgentStateRequest - Required fields missing or invalid on PUT /v1/cs/voip-users/{id}/state.
-2831 = AgentStateWriteConflict - Supplied state timestamp is older than or equal to the currently stored state timestamp (PUT /v1/cs/voip-users/{id}/state returns 409).
-2830 = AgentStateNotFound - No voip user record matches the supplied id for the given account (PUT /v1/cs/voip-users/{id}/state).
-2829 = VoiceMailInsertFailed - Voicemail insert failed at the database layer (no rows written).
-2828 = InvalidVoiceMailRequest - Required fields missing or invalid on POST /v1/cs/voicemails or PUT /v1/cs/voicemails/{id}.
-2827 = VoiceMailNotFound - No voicemail record matches the supplied id for the given account.
-2826 = CallLogInsertFailed - Call log insert failed at the database layer (no rows written).
-2825 = InvalidPluginOperationBatch - Items list is missing or empty on POST /v1/cs/plugin-operations/batch.
-2824 = InvalidCallLogDetailBatch - Items list is missing or empty on POST /v1/cs/call-log-details/batch.
-2823 = CallLogNotFound - No call log record matches the supplied id for the given account.
-2822 = InvalidCallLogRequest - Required fields missing or invalid on POST /v1/cs/call-logs or PUT /v1/cs/call-logs/{id}.
-2821 = InvalidActiveHoursQuery - tableType or tableId query parameter missing or invalid on GET /v1/cs/active-hours/check.
-2820 = CompanyNotFound - No company matches the supplied phone on GET /v1/cs/companies/by-phone.
-2819 = ContactNotFound - No contact matches the supplied phone on GET /v1/cs/contacts/by-phone.
-2818 = InvalidPhoneNumber - Phone number on call-time lookup endpoints could not be parsed into a valid normalized form after libphonenumber TR/region-independent parse and regex fallback.
-2817 = MissingAccountId - Query string accountId missing or non-positive on /v1/cs/* GET endpoint (CSD-08).
-2816 = InvalidRequestBody - Request body on POST /v1/cs/events/publish failed to deserialize into the expected payload shape for its EventType (CSD-07)
-2815 = InvalidEventType - EventEnvelope.EventType on POST /v1/cs/events/publish does not match any known CallServer event type (CSD-07)
-2814 = InvalidCorrelationId - Caller-provided X-Correlation-Id does not match the expected format
-2813 = InactiveSipServer - The sip_servers row referenced by X-Sip-Server-Id is inactive (IS_ACTIVE=0)
-2812 = MissingSipServerIdHeader - X-Sip-Server-Id header is missing on an endpoint that requires tenant context
-2811 = TenantMismatch - X-Sip-Server-Id header does not match an active sip_servers row
-2810 = InvalidApiKey - Missing or invalid X-API-Key header on /v1/cs/* endpoint
-2802 = SipServerInUse - The sip_servers row is referenced by at least one voip_user/voip_settings/ivr_plugin/automation/survey and cannot be deleted
-2801 = SipServerIdExists - A sip_servers row already exists with the given server_id (UNIQUE constraint)
-2800 = SipServerNotFound - The requested sip_servers row does not exist
-2702 = PasswordExpired
-2701 = PasswordCompromised
-2700 = PasswordInHistory
-2699 = ChatTagDepartmentRequired
-2698 = TransferTargetForbiddenDepartment
-2697 = UserDepartmentRequired
-2696 = DeskDepartmentRequired
-2695 = UserGroupDepartmentRequired
-2694 = SlaPolicyDepartmentRequired
-2693 = CustomDashboardDepartmentRequired
-2692 = DashboardDepartmentRequired
-2691 = AutomationDepartmentRequired
-2690 = UserAvailabilityDepartmentRequired
-2681 = SurveyDepartmentImmutable
-2680 = SurveyDepartmentRequired
-2670 = CustomFieldDepartmentRequired
-2660 = CategoryDepartmentRequired
-2650 = SavedFilterDepartmentRequired
-2640 = TemplateDepartmentRequired
-2630 = SavedReplyDepartmentRequired
-2620 = ForbiddenWordDepartmentRequired
-2611 = IntegrationDepartmentImmutable
-2610 = IntegrationDepartmentRequired
-2602 = InvalidAnnouncementDateRange
-2601 = AnnouncementDepartmentRequired
-2600 = DuplicateAnnouncement
-2500 = LastDeskDelete
-2400 = DuplicatePipeline
-2300 = ForbiddenWords
-2201 = MfaEnforcedCantDisable
-2200 = DuplicateCompany
-2100 = DuplicatePhone
-2002 = DuplicateSlaPolicyMetric
-2001 = DuplicateSlaStats
-2000 = DuplicateSlaPolicy
-1951 = DuplicateDialerDtmf
-1950 = DuplicateDialerName
-1930 = TrialActiveCardSaved
-1926 = IntegrationDisabledDueToFailures
-1925 = IntegrationLoginFailed
-1924 = CouldntRetrieveIntegrationDetails
-1923 = TextIsTooLong
-1922 = DuplicateIntegration
-1921 = OauthPermissionError
-1920 = IntegrationExistsInAnotherAccount
-1919 = IntegrationAccountNotFound
-1918 = WebhookSetupError
-1917 = CantDeleteCard
-1916 = UnknownCardNumber
-1915 = PaymentSystemError
-1914 = ThreedSecureError
-1913 = VerificationError
-1912 = BankNotRegistered - Bank is not registered in the system
-1911 = CardholderOrBankNotRegistered - Cardholder or bank is not registered in the system
-1910 = ThreedInvalidVerification
-1909 = PaymentIdNotFound
-1908 = ConversationIdNotFound
-1907 = Empty3DsPage
-1906 = CantSaveSubscription
-1905 = CantRegisterCard
-1904 = PaymentCanceled
-1903 = FraudSuspect
-1902 = EmptyBasketItems
-1901 = DebitCardNotAllowed
-1900 = BinNotFound
-1803 = ClosedTicketCantBeUpdated - Closed tickets are locked. They can't be reopened or updated in any way.
-1802 = ErrorDuplicateTemplate
-1802 = ErrorDuplicateTemplate
-1801 = ErrorDuplicateCustomField
-1203 = InvalidPromotionForPlan
-1202 = PromoCodeAlreadyUsed
-1201 = PromoCodeExpired
-1200 = InvalidPromoCode
-905 = DuplicateCategory
-822 = GatewayNotRegistered - Click-to-call pre-flight rejected: target voip_gateway_providers row has REGISTERED=0 (SIP REGISTER with the carrier failed or is in progress).
-821 = MinActiveAgentLimitReached
-820 = SipRegisterError
-819 = DuplicateIvrDial
-818 = DuplicateIvrName
-817 = DuplicateVoipProvider
-816 = DuplicateExtension
-815 = DuplicateVoipUser
-814 = DuplicateCallCenterQueue
-813 = DuplicateDialPlanRoute
-812 = DuplicateDialPlanName
-811 = DuplicateWorkingHours
-421 = MaxDeskLimitReached
-417 = DuplicateContactGroup
-416 = MaxFileStorageLimitReached
-415 = MaxExtensionLimitReached
-413 = MaxAgentLimitReached
-412 = MaxEmailReceiveLimitReached
-411 = MaxEmailSendLimitReached
-409 = MaxEmailAccountLimitReached
-408 = MaxChatMessageLimitReached
-406 = MaxChatWidgetLimitReached
-405 = MaxTaskLimitReached
-404 = MaxDealLimitReached
-403 = MaxCompanyLimitReached
-402 = MaxContactLimitReached
-401 = MaxContactGroupLimitReached
-400 = MaxUserLimitReached
-340 = ChatbotCarouselImageNotOwned - Carousel image URL is external or belongs to another account; images must use the caller's Infoset upload area (HTTP 422).
-339 = ChatbotConnectionDepartmentForbidden
-338 = ChatbotConnectionSecretRequired
-337 = ChatbotConnectionInvalid
-336 = ChatbotConnectionNotFound
-335 = ChatbotStaleUpdate - The chatbot changed after the client loaded it, so saving would overwrite someone else's edit (HTTP 409). `PUT /chatbots/{id}` writes every config column, so a stale payload from the Settings tab would revert the flow (and vice versa); the client must reload and retry.
-334 = ChatbotConcurrentPublish - Another publish for the same chatbot won the race; retry (HTTP 409).
-333 = ChatbotLifecycleWriteFailed - Publish/rollback/archive write failed unexpectedly (HTTP 500).
-332 = ChatbotPreviewObjectNotAllowed - A chatbot preview referenced objects outside the chatbot's own OBJECTS list (HTTP 422).
-331 = ChatbotPreviewObjectLimitExceeded - The chatbot mode cannot be changed after the bot has been published (HTTP 422).
-329 = ChatbotNotFound - The chatbot does not exist or is not visible to the caller's brands (HTTP 404).
-328 = ChatbotPublishPreconditionFailed - The chatbot cannot be published because one or more preconditions (brand, channel, working hours) are not met (HTTP 422).
-327 = ChatbotVersionNotFound - The submitted chatbot mode is not available yet; only Flow is supported in v1 (HTTP 422).
-325 = ChatMessageEditNotAuthorized
-324 = ChatHubConnectedRoomLimitExceeded
-323 = ChatHubVisitorMessageLimitExceeded
-322 = ChatHubConnectionLimitExceeded
-321 = AccessDenied
-320 = CantSendMessageWithIntegration
-319 = CantSendChatMessage
-318 = EmptyChatMesage
-317 = ChatNotFound
-316 = RoomNotFound
-315 = ConnectedUserNotFound
-314 = ChatRoomClosed
-313 = InvalidChatbot
-312 = InvalidConnection
-311 = InvalidHmacHash
-309 = DuplicateChatMessage
-308 = DuplicateOutboundMessage
-302 = CantSaveChatMsg
-301 = CantCreateChatRoom
-214 = CantSaveMailAccount
-213 = SmtpConnectionError
-212 = ImapConnectionError
-209 = DuplicateAutomation
-202 = DuplicateEmail
-195 = EmailAttachmentSizeLimitExceeded
-194 = CantSendEmail - E-mail could not be sent
-151 = InvalidDomainName
-97 = AccountInvoiceNotFound
-96 = CantSubscribeToFreePlan
-95 = PlanNotFound
-91 = EmailNotVerified
-90 = CaptchaVerificationFailed - CAPTCHA verification failed
-89 = DuplicateUser
-88 = BadInput - Missing or incorrect parameters
-87 = LinkExpired - Link is expired
-86 = VerificationMailAlreadySent - The confirmation mail has already been sent to this address
-83 = CantCreateAccount
-82 = TooManyAccountsFromIp
-81 = DuplicateAccountEmail
-80 = AccountDisabled
-64 = InvalidFileType
-63 = NoPaymentMethod
-60 = CantDeleteFile
-23 = RateLimited
-22 = IpNotWhitelisted
-21 = AuthenticationError
-13 = InvalidOpenIdToken
-12 = InvalidEmail
-9 = InvalidMfaCode
-8 = RecordSaveError
-7 = InvalidToken
-4 = AccountNotFound
-1 = Error - General error

- `allowedExtensions` string, nullable ## Other responses - `400` — Bad Request --- [API](https://skmtc.dev/infoset/apis/infoset-rest-api.md) · [All operations](https://skmtc.dev/infoset/apis/infoset-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/infoset/infoset-rest-api/revisions/f5bc39a1ac15/schema)