PATCH /api/v1/accounts/{accountId}/access
Share a mailbox you own with every member or with selected members, make it private, or hand it to another member.
Share a mailbox you own with every member or with selected members, make it private, or hand it to another member.
Authentication
Pass a Fluxmail member session as a bearer token. API keys cannot use this endpoint.
Request
curl 'http://localhost:8977/api/v1/accounts/acct_123/access' \
-X PATCH \
-H "Authorization: Bearer $FLUXMAIL_SESSION" \
-H "Content-Type: application/json" \
--data '{}'Parameters
| Name | Location | Required | Type | Details |
|---|---|---|---|---|
accountId | path | Yes | string | Minimum length: 1. |
Request body
Content type: application/json
{
"type": "object",
"properties": {
"ownerMemberId": {
"type": "string"
},
"sharedWithAll": {
"type": "boolean"
},
"grantedMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100
}
},
"additionalProperties": false
}Responses
| Status | Description | Content type |
|---|---|---|
200 | Success | application/json |
400 | Invalid request | application/json |
401 | Authentication required | application/json |
403 | Permission denied | application/json |
404 | Not found | application/json |
409 | Conflict | application/json |
413 | Request body too large | application/json |
429 | Too many attempts | application/json |
200 response
{
"type": "object",
"properties": {
"data": {
"nullable": true
}
},
"additionalProperties": {
"nullable": true
}
}Last updated
POST /api/v1/admin/imap/tests
Test IMAP and SMTP settings without saving an account. Requires admin.accounts.
PATCH /api/v1/admin/accounts/{accountId}
Change ownership or sharing of a mailbox you own. Requires admin.accounts. To move another member's mailboxes, remove the member with a new owner for their mailboxes.