Shared mailboxes
Open a Microsoft 365 shared mailbox with an account's grant.
Guides: Shared mailboxes.
| Method | Path | Operation | Scope |
|---|---|---|---|
POST | /v1/accounts/{accountId}/shared-mailboxes | Open a shared mailbox with an account's grant | write |
POST
Runs against the live API with the key you enter: this change really happens. Use a key limited to a test account.
Creates (or re-points) an account for a shared mailbox the delegating account's user can access, authenticated with that account's grant: Graph addresses it as /users/{email}; an Exchange IMAP account logs in as user\shared with XOAUTH2. Gmail has no delegated shared mailboxes: add them through a Google domain-wide delegation connection.
Required scope: write.
accountId*stringFormat
uuidapplication/json- body
email*stringFormat
emailLength
length <= 320displayName?stringLength
length <= 255externalRef?stringLength
length <= 255settings?OK
application/json- response
id*stringFormat
uuidexternalRef*string|nullprovider*AccountProviderValue in
"gmail""graph""imap"email*stringdisplayName*string|nulloauthAppId*|nullcloud*|nullstatus*AccountStatusValue in
"active""paused""reauth_required""disabled"statusReason*string|nullsettings*settingsOverride*runtime*|nullimap*|nullauth*initializedAt*|nullcalendarInitializedAt*|nullcontactsInitializedAt*|nullcreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timeExample Request
curl -X POST 'https://api.workwae.com/v1/accounts/6f1c2a4e-8b3d-4e5f-9a7b-1c2d3e4f5a6b/shared-mailboxes' \ -H 'Content-Type: application/json' \ -d '{ "email": "ada@example.com"}'Example Response
{ "id": "c4e6a8b0-1d3f-4a5c-8e7b-9d1f3a5c7e9b", "externalRef": "user_42", "provider": "gmail", "email": "string", "displayName": "string", "oauthAppId": "c6e11c75-050f-4212-9cff-bddb4fb07e36", "cloud": "global", "status": "active", "statusReason": "string", "settings": { "bodyStorage": "none", "syncWindowDays": 1, "calendarEnabled": true, "contactsEnabled": true, "undoSendSeconds": 0, "trackOpens": true, "trackClicks": true, "trackingHoneypot": true }, "settingsOverride": { "bodyStorage": "none", "syncWindowDays": 1, "calendarEnabled": true, "contactsEnabled": true, "undoSendSeconds": 0, "trackOpens": true, "trackClicks": true, "trackingHoneypot": true }, "runtime": { "state": "pending", "detail": "string", "ownerInstanceId": "b31a377d-3f38-46d6-b670-15babc0f5625", "updatedAt": "2026-05-04T09:30:00.000Z" }, "imap": { "imap": { "host": "string", "port": 0, "security": "tls", "user": "string" }, "smtp": { "host": "string", "port": 0, "security": "tls", "user": "string" }, "auth": "password", "appendSent": true, "dav": { "calendarUrl": "string", "contactsUrl": "string", "user": "string", "auth": "imap_password" } }, "auth": { "method": "oauth", "orgConnectionId": "17f753c8-b2ec-494b-9468-6e20a9a2f99c", "delegateAccountId": "016ade53-f197-47ea-bd0e-48fda92e431f" }, "initializedAt": "2026-05-04T09:30:00.000Z", "calendarInitializedAt": "2026-05-04T09:30:00.000Z", "contactsInitializedAt": "2026-05-04T09:30:00.000Z", "createdAt": "2026-05-04T09:30:00.000Z", "updatedAt": "2026-05-04T09:30:00.000Z"}