Admin management of genie email inbox provisioning state
agent-mailboxes is an admin-only resource for monitoring and managing the email inbox attached to each genie. Every genie that has email reception enabled gets a provisioned mailbox entry; this resource lets admins view the full mailbox roster and suspend, resume, or deprovision individual mailboxes.
All actions on this resource require an internal admin account. Requests from non-admin users are rejected with 403 Forbidden.
List all mailboxes
Returns every genie mailbox across all users, joined with the owning genie and user details.
string
required
Must be "agent-mailboxes"
string
required
Must be "all"
object
Show properties
number
Maximum number of mailboxes to return. Default 50, max 100.
number
Number of records to skip for pagination. Default 0.
boolean
Whether the request succeeded.
object
Show properties
array
Show item properties
string
Mailbox UUID.
string
UUID of the genie this mailbox belongs to.
string | null
Display name of the owning genie.
string | null
User ID of the genie owner.
string | null
Email address of the genie owner.
string | null
Full name of the genie owner.
string
The provisioned mailbox email address.
string | null
Internal account reference used by the mail system, or null if not yet provisioned.
string | null
OAuth grant identifier for the mailbox connection, or null.
string
Current provisioning status. One of "provisioned", "suspended", or "unavailable".
string | null
Most recent provisioning error message, or null if healthy.
boolean
Whether the mailbox is currently in test mode.
boolean
Whether the genie’s email replies can carry its own Resources and knowledge-base files as attachments and links.
Suspends or resumes a mailbox and/or updates the escalation address. At least one field (action or escalation_address) must be provided.
string
required
Must be "agent-mailboxes"
string
required
Must be "update"
string
required
The mailbox UUID.
object
required
Show properties
string
Lifecycle transition. Must be "suspend" or "resume". Omit to leave the current status unchanged.
string | null
Fallback email address for unhandled messages. Must be a valid email address, or null to clear the current value. Omit this key entirely to leave it unchanged.
Permanently removes a mailbox — deletes the local record and fully removes the account from the mail system. The genie stays without a mailbox until one is created again with agent-mailboxes-self provision.
string
required
Must be "agent-mailboxes"
string
required
Must be "delete"
string
required
The mailbox UUID.
boolean
object
Show properties
boolean
true when the mailbox was successfully deprovisioned.
This action fully removes the mailbox from the mail system and deletes the local record. It does not delete the underlying genie. The action is idempotent — a 404 from the mail system is treated as success. If the mail system refuses the delete, the request fails and the mailbox record is restored unchanged.
Missing ID, no valid update fields, or invalid escalation_address
INVALID_ACTION
400
Unknown action
INTERNAL_ERROR
500
Mail system error or local sync failure
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Help Genie","description":"API documentation for the Help Genie voice AI platform","colors":{"primary":"#4E9CFF","light":"#7BB8FF","dark":"#2B7FE8"},"logo":{"light":"https://mintcdn.com/helpgenie/a134Jyg1BOpqw0vP/logo/light.png?fit=max\u0026auto=format\u0026n=a134Jyg1BOpqw0vP\u0026q=85\u0026s=f29d097a201254a8a750843d0d692c50","dark":"https://mintcdn.com/helpgenie/a134Jyg1BOpqw0vP/logo/dark.png?fit=max\u0026auto=format\u0026n=a134Jyg1BOpqw0vP\u0026q=85\u0026s=f00cbee677f1f3a3f46d463cb7cbad38","href":"https://helpgenie.ai"},"favicon":"https://mintcdn.com/helpgenie/17V8AwVjtycIuhCm/favicon.svg?fit=max\u0026auto=format\u0026n=17V8AwVjtycIuhCm\u0026q=85\u0026s=8a7865e1c10e3dacc378789f70f5ef6e","navbar":{"links":[{"href":"mailto:support@helpgenie.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://helpgenie.ai/dashboard"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/helpgenie"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Help Genie Voice","icon":"microphone","href":"https://helpgenie.ai"},{"anchor":"Help Genie Mail","icon":"envelope","href":"https://mail.helpgenie.ai"},{"anchor":"Help Genie Outbound","icon":"phone","href":"https://outbound.helpgenie.ai"},{"anchor":"Help Genie Sync","icon":"arrows-rotate","href":"https://sync.helpgenie.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"helpgenie","hasAudioNarration":false,"actualSubdomain":"helpgenie","customDomains":["docs.helpgenie.ai"],"gitSource":{"type":"github","owner":"help-genie-ai","repo":"help-genie-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af6f87607e6a796f0fd81d2","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":54},{"language":"default","tag":"Voice","count":37},{"language":"default","tag":"Overview","count":20},{"language":"default","tag":"Expanded Platform","count":16},{"language":"default","tag":"Sync","count":13},{"language":"default","tag":"Mail","count":11},{"language":"default","tag":"Outbound","count":9},{"language":"default","tag":"Knowledge","count":6},{"language":"default","tag":"Working with mail","count":6},{"language":"default","tag":"Configuring a Genie","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/agent-mailboxes","slug":"/api-reference/agent-mailboxes","pageMetadata":{"title":"Agent mailboxes","description":"Admin management of genie email inbox provisioning state","href":"/api-reference/agent-mailboxes"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Admin management of genie email inbox provisioning state\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,ParamField,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.code,{children:`agent-mailboxes`}),` is an admin-only resource for monitoring and managing the email inbox attached to each genie. Every genie that has email reception enabled gets a provisioned mailbox entry; this resource lets admins view the full mailbox roster and suspend, resume, or deprovision individual mailboxes.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`All actions on this resource require an internal admin account. Requests from non-admin users are rejected with `,_jsx(_components.code,{children:`403 Forbidden`}),`.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`list-all-mailboxes`,children:`List all mailboxes`}),`\n`,_jsx(_components.p,{children:`Returns every genie mailbox across all users, joined with the owning genie and user details.`}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"agent-mailboxes\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"all\"`})]})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`limit`,type:`number`,id:`param-limit`,children:_jsxs(_components.p,{children:[`Maximum number of mailboxes to return. Default `,_jsx(_components.code,{children:`50`}),`, max `,_jsx(_components.code,{children:`100`}),`.`]})}),_jsx(ParamField,{body:`offset`,type:`number`,id:`param-offset`,children:_jsxs(_components.p,{children:[`Number of records to skip for pagination. Default `,_jsx(_components.code,{children:`0`}),`.`]})})]})}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Whether the request succeeded.`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-1`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`mailboxes`,type:`array`,id:`param-mailboxes`,children:_jsxs(Expandable,{title:`item properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:`Mailbox UUID.`}),_jsx(ResponseField,{name:`agent_id`,type:`string`,id:`param-agent-id`,children:`UUID of the genie this mailbox belongs to.`}),_jsx(ResponseField,{name:`agent_name`,type:`string | null`,id:`param-agent-name`,children:`Display name of the owning genie.`}),_jsx(ResponseField,{name:`user_id`,type:`string | null`,id:`param-user-id`,children:`User ID of the genie owner.`}),_jsx(ResponseField,{name:`user_email`,type:`string | null`,id:`param-user-email`,children:`Email address of the genie owner.`}),_jsx(ResponseField,{name:`user_name`,type:`string | null`,id:`param-user-name`,children:`Full name of the genie owner.`}),_jsx(ResponseField,{name:`email_address`,type:`string`,id:`param-email-address`,children:`The provisioned mailbox email address.`}),_jsxs(ResponseField,{name:`account_id`,type:`string | null`,id:`param-account-id`,children:[`Internal account reference used by the mail system, or `,_jsx(_components.code,{children:`null`}),` if not yet provisioned.`]}),_jsxs(ResponseField,{name:`grant_id`,type:`string | null`,id:`param-grant-id`,children:[`OAuth grant identifier for the mailbox connection, or `,_jsx(_components.code,{children:`null`}),`.`]}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`Current provisioning status. One of `,_jsx(_components.code,{children:`\"provisioned\"`}),`, `,_jsx(_components.code,{children:`\"suspended\"`}),`, or `,_jsx(_components.code,{children:`\"unavailable\"`}),`.`]})}),_jsxs(ResponseField,{name:`last_error`,type:`string | null`,id:`param-last-error`,children:[`Most recent provisioning error message, or `,_jsx(_components.code,{children:`null`}),` if healthy.`]}),_jsx(ResponseField,{name:`test_mode`,type:`boolean`,id:`param-test-mode`,children:`Whether the mailbox is currently in test mode.`}),_jsx(ResponseField,{name:`attach_resources`,type:`boolean`,id:`param-attach-resources`,children:`Whether the genie’s email replies can carry its own Resources and knowledge-base files as attachments and links.`}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at`,children:`ISO 8601 creation timestamp.`}),_jsx(ResponseField,{name:`updated_at`,type:`string`,id:`param-updated-at`,children:`ISO 8601 last-updated timestamp.`})]})}),_jsx(ResponseField,{name:`count`,type:`number`,id:`param-count`,children:`Total number of mailboxes matching the query.`}),_jsx(ResponseField,{name:`limit`,type:`number`,id:`param-limit-1`,children:`The page size used for this request.`}),_jsx(ResponseField,{name:`offset`,type:`number`,id:`param-offset-1`,children:`The offset used for this request.`})]})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`ApiService.invoke()`,numberOfLines:`2`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"agent-mailboxes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"all\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`undefined`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`limit:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 50`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`offset:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`mailboxes`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`count`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`limit`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`offset`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_ADMIN_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"resource\": \"agent-mailboxes\", \"action\": \"all\", \"data\": {\"limit\": 50, \"offset\": 0}}'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Response`,numberOfLines:`27`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`27`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mailboxes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"mbx-uuid-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agent_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"550e8400-e29b-41d4-a716-446655440000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agent_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Support Genie\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"user_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"usr-uuid-456\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"user_email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"owner@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"user_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Jane Smith\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email_address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"support-genie@mail.helpgenie.ai\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"acct-abc123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"grant_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"grant-xyz789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"provisioned\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"last_error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"test_mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"attach_resources\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-01-10T08:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-01-10T08:00:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"limit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`50`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"offset\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`update-mailbox`,children:`Update mailbox`}),`\n`,_jsxs(_components.p,{children:[`Suspends or resumes a mailbox and/or updates the escalation address. At least one field (`,_jsx(_components.code,{children:`action`}),` or `,_jsx(_components.code,{children:`escalation_address`}),`) must be provided.`]}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-1`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"agent-mailboxes\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-1`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"update\"`})]})}),`\n`,_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id-1`,children:_jsx(_components.p,{children:`The mailbox UUID.`})}),`\n`,_jsx(ParamField,{body:`data`,type:`object`,required:true,id:`param-data-2`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`action`,type:`string`,id:`param-action-2`,children:_jsxs(_components.p,{children:[`Lifecycle transition. Must be `,_jsx(_components.code,{children:`\"suspend\"`}),` or `,_jsx(_components.code,{children:`\"resume\"`}),`. Omit to leave the current status unchanged.`]})}),_jsx(ParamField,{body:`escalation_address`,type:`string | null`,id:`param-escalation-address`,children:_jsxs(_components.p,{children:[`Fallback email address for unhandled messages. Must be a valid email address, or `,_jsx(_components.code,{children:`null`}),` to clear the current value. Omit this key entirely to leave it unchanged.`]})})]})}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-1`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-3`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`ok`,type:`boolean`,id:`param-ok`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` when the update was applied successfully.`]})})})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`ApiService.invoke()`,numberOfLines:`9`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Suspend a mailbox`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"agent-mailboxes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"update\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"mbx-uuid-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` action:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"suspend\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Update escalation address only`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"agent-mailboxes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"update\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"mbx-uuid-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` escalation_address:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"oncall@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`9`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_ADMIN_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"resource\": \"agent-mailboxes\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"update\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"id\": \"mbx-uuid-001\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data\": { \"action\": \"suspend\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Response`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`delete-mailbox`,children:`Delete mailbox`}),`\n`,_jsxs(_components.p,{children:[`Permanently removes a mailbox — deletes the local record and fully removes the account from the mail system. The genie stays without a mailbox until one is created again with `,_jsxs(_components.a,{href:`/api-reference/agent-mailboxes-self#provision-mailbox`,children:[_jsx(_components.code,{children:`agent-mailboxes-self`}),` provision`]}),`.`]}),`\n`,_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource-2`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"agent-mailboxes\"`})]})}),`\n`,_jsx(ParamField,{body:`action`,type:`string`,required:true,id:`param-action-3`,children:_jsxs(_components.p,{children:[`Must be `,_jsx(_components.code,{children:`\"delete\"`})]})}),`\n`,_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id-2`,children:_jsx(_components.p,{children:`The mailbox UUID.`})}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success-2`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data-4`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`ok`,type:`boolean`,id:`param-ok-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` when the mailbox was successfully deprovisioned.`]})})})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`This action fully removes the mailbox from the mail system and deletes the local record. It does not delete the underlying genie. The action is idempotent — a `,_jsx(_components.code,{children:`404`}),` from the mail system is treated as success. If the mail system refuses the delete, the request fails and the mailbox record is restored unchanged.`]})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`ApiService.invoke()`,numberOfLines:`1`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ApiService`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`invoke`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"agent-mailboxes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"delete\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"mbx-uuid-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.helpgenie.ai/v1`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer hg_live_YOUR_ADMIN_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"resource\": \"agent-mailboxes\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"action\": \"delete\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"id\": \"mbx-uuid-001\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Response`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`FORBIDDEN`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:`Caller is not an internal admin`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_FOUND`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Mailbox not found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VALIDATION_ERROR`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[`Missing ID, no valid update fields, or invalid `,_jsx(_components.code,{children:`escalation_address`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID_ACTION`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`Unknown action`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`INTERNAL_ERROR`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:`Mail system error or local sync failure`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Agent mailboxes","description":"Admin management of genie email inbox provisioning state","href":"/api-reference/agent-mailboxes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"List all mailboxes","slug":"list-all-mailboxes","depth":2,"children":[]},{"title":"Update mailbox","slug":"update-mailbox","depth":2,"children":[]},{"title":"Delete mailbox","slug":"delete-mailbox","depth":2,"children":[]},{"title":"Error codes","slug":"error-codes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"helpgenie","siteName":"Help Genie","title":"Agent mailboxes - Help Genie","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T11:31:06.914Z","originalFileLocation":"api-reference/agent-mailboxes.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Admin management of genie email inbox provisioning state\">\u003cmeta data-mint-head name=\"application-name\" content=\"Help Genie\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Agent mailboxes - Help Genie\">\u003cmeta data-mint-head property=\"og:description\" content=\"Admin management of genie email inbox provisioning state\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Help Genie\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.helpgenie.ai/api-reference/agent-mailboxes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://helpgenie.mintlify.site/_mintlify/api/og/v2?division=Expanded+Platform\u0026amp;title=Agent+mailboxes\u0026amp;description=Admin+management+of+genie+email+inbox+provisioning+state\u0026amp;theme=fc0888b7de96c166e1873963\u0026amp;signature=4abe12230270cae60cb228f1453d2009332bbd0db16bee74e0d1a3d02039293f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Agent mailboxes - Help Genie\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Admin management of genie email inbox provisioning state\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://helpgenie.mintlify.site/_mintlify/api/og/v2?division=Expanded+Platform\u0026amp;title=Agent+mailboxes\u0026amp;description=Admin+management+of+genie+email+inbox+provisioning+state\u0026amp;theme=fc0888b7de96c166e1873963\u0026amp;signature=4abe12230270cae60cb228f1453d2009332bbd0db16bee74e0d1a3d02039293f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/helpgenie/ypdPY4Ery9DMUCww/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Help Genie\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4E9CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.helpgenie.ai/api-reference/agent-mailboxes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agent-mailboxes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.helpgenie.ai/#organization\",\"name\":\"Help Genie\",\"url\":\"https://docs.helpgenie.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/helpgenie/a134Jyg1BOpqw0vP/logo/light.png?fit=max\u0026auto=format\u0026n=a134Jyg1BOpqw0vP\u0026q=85\u0026s=f29d097a201254a8a750843d0d692c50\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.helpgenie.ai#website\",\"name\":\"Help Genie\",\"url\":\"https://docs.helpgenie.ai\",\"publisher\":{\"@id\":\"https://docs.helpgenie.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes#webpage\",\"url\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes\",\"name\":\"Agent mailboxes\",\"description\":\"Admin management of genie email inbox provisioning state\",\"dateModified\":\"2026-11-09T11:31:06.914Z\",\"isPartOf\":{\"@id\":\"https://docs.helpgenie.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Expanded Platform\",\"item\":\"https://docs.helpgenie.ai/api-reference/analytics\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agent mailboxes\",\"item\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes#article\",\"headline\":\"Agent mailboxes\",\"name\":\"Agent mailboxes\",\"description\":\"Admin management of genie email inbox provisioning state\",\"url\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.helpgenie.ai/api-reference/agent-mailboxes#webpage\"},\"dateModified\":\"2026-11-09T11:31:06.914Z\",\"publisher\":{\"@id\":\"https://docs.helpgenie.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.helpgenie.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Help Genie\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Help Genie\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/agent-mailboxes.md","siteName":"Help Genie","nav":{"global":{"anchors":[{"anchor":"Help Genie Voice","icon":"microphone","href":"https://helpgenie.ai"},{"anchor":"Help Genie Mail","icon":"envelope","href":"https://mail.helpgenie.ai"},{"anchor":"Help Genie Outbound","icon":"phone","href":"https://outbound.helpgenie.ai"},{"anchor":"Help Genie Sync","icon":"arrows-rotate","href":"https://sync.helpgenie.ai"}]},"tabs":[{"tab":"Getting started","icon":"compass","pages":[{"title":"Getting started","href":""}]},{"tab":"API reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Making requests","href":"/api-reference/making-requests"},{"title":"Error handling","href":"/api-reference/errors"}]},{"group":"Public (unauthenticated)","pages":[{"title":"Public Genies","href":"/api-reference/public-genies"},{"title":"Public Help Hub","href":"/api-reference/public-help-hub"},{"title":"Activation (Public)","href":"/api-reference/activation"},{"title":"Help Hub","href":"/api-reference/help-hub"}]},{"group":"Agents","pages":[{"title":"Genies","href":"/api-reference/genies"},{"title":"Genie groups","href":"/api-reference/genie-groups"},{"title":"Conversations","href":"/api-reference/conversations"},{"title":"Genie Meetings","href":"/api-reference/genie-meetings"}]},{"group":"Knowledge","pages":[{"title":"Knowledge base","href":"/api-reference/knowledge-base"},{"title":"Knowledge Recommendations","href":"/api-reference/knowledge-recommendations"},{"title":"Document folders","href":"/api-reference/document-folders"},{"title":"Genie Documents","href":"/api-reference/genie-documents"}]},{"group":"CRM","pages":[{"title":"Leads","href":"/api-reference/leads"}]},{"group":"Marketplace","pages":[{"title":"Marketplace","href":"/api-reference/marketplace"}]},{"group":"Platform","pages":[{"title":"Profiles","href":"/api-reference/profiles"},{"title":"Teams","href":"/api-reference/teams"},{"title":"Activities","href":"/api-reference/activities"},{"title":"Goals","href":"/api-reference/goals"},{"title":"API keys","href":"/api-reference/api-keys"}]},{"group":"Telephony","pages":[{"title":"Phone numbers","href":"/api-reference/phone-numbers"},{"title":"QR codes","href":"/api-reference/qr-code"}]},{"group":"Worker genies","pages":[{"title":"Worker genies","href":"/api-reference/worker-genies"}]},{"group":"Quality \u0026 Compliance","pages":[{"title":"Brand Integrity","href":"/api-reference/brand-integrity"}]},{"group":"Access Control","pages":[{"title":"Genie Access","href":"/api-reference/genie-access"}]},{"group":"Intelligence","pages":[{"title":"Insights","href":"/api-reference/insights"}]},{"group":"Education","pages":[{"title":"Learn","href":"/api-reference/learn"}]},{"group":"Voice","pages":[{"title":"Voices","href":"/api-reference/voices"},{"title":"Voice collections","href":"/api-reference/voice-collections"},{"title":"Preselected voices","href":"/api-reference/preselected-voices"},{"title":"Pronunciation Vaults","href":"/api-reference/pronunciation-vaults"}]},{"group":"Integrations","pages":[{"title":"Context Sources","href":"/api-reference/context-sources"},{"title":"Escalation Webhooks","href":"/api-reference/escalation-webhooks"},{"title":"Chat channels","href":"/api-reference/chat-channels"},{"title":"MCP connections","href":"/api-reference/mcp-connections"}]},{"group":"Expanded Platform","pages":[{"title":"Analytics","href":"/api-reference/analytics"},{"title":"Billing","href":"/api-reference/billing"},{"title":"Branding","href":"/api-reference/branding"},{"title":"Portals","href":"/api-reference/portals"},{"title":"Activation Packs","href":"/api-reference/activation-packs"},{"title":"Print Orders","href":"/api-reference/print-orders"},{"title":"Playbooks","href":"/api-reference/playbooks"},{"title":"Demo Genies","href":"/api-reference/demo-genies"},{"title":"Email Templates","href":"/api-reference/email-templates"},{"title":"Email Logs","href":"/api-reference/email-logs"},{"title":"System Emails","href":"/api-reference/system-emails"},{"title":"Generate Logo","href":"/api-reference/generate-logo"},{"title":"Capabilities","description":"Runtime discovery of resources, actions, genie capabilities and platform guides","href":"/api-reference/capabilities"},{"title":"Agent mailboxes","href":"/api-reference/agent-mailboxes"},{"title":"Genie mailbox (self)","description":"Owner-facing provisioning and management of your genie's email inbox","href":"/api-reference/agent-mailboxes-self"},{"title":"Mail tenant credentials","href":"/api-reference/mail-tenant-credentials"}]}]},{"tab":"Voice","icon":"microphone","pages":[{"title":"Voice","href":"/voice-guide/my-genies-list"}]},{"tab":"Mail","icon":"envelope","pages":[{"title":"Mail","href":"/mail-guide/introduction"}]},{"tab":"Outbound","icon":"phone","pages":[{"title":"Outbound","href":"/outbound-guide/introduction"}]},{"tab":"Sync","icon":"arrows-rotate","pages":[{"title":"Sync","href":"/sync-guide/introduction"}]}]},"basePath":"","title":"Agent mailboxes - Help Genie","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}