sharedMailbox

9 endpoints
GET/rest/sharedMailboxes

Return current user's shared mailboxes

Description:

Returns a paginated list of shared mailboxes available to the current user.

Precondition:

The user must be authenticated and belong to an internal domain.

Response:

A list of shared mailboxes is returned.
Parameters
Query Parameters
orderBy
Optional
string

Sort order for the results.
Allowed values: modified:asc, modified:desc, active:asc, active:desc.

limit
Optional
integer

Maximum number of results to return.

offset
Optional
integer

Number of items to skip before returning results, for pagination.

active
Optional
boolean

Filter by active status. If true, returns only active shared mailboxes; if false, returns only inactive ones.

id:in
Optional
string[]

Comma-separated list of shared mailbox user IDs to filter by. (Recommended request size <= 100)

Responses

The shared mailboxes are returned successfully.

id
string
active
boolean

Indicates whether the shared mailbox is active.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

total
integer

Total number of items available.

limit
integer

Maximum number of items returned per page.

offset
integer

Number of items skipped before the current page.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_NOT_INTERNAL_DOMAIN

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/sharedMailboxes" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

url = "https://{instance}.kiteworks.com/rest/sharedMailboxes"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "data": [ { "id": "string", "active": true, "user": {}, "members": [ "..." ] } ], "metadata": {} }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_NOT_INTERNAL_DOMAIN", "message": "The email is not internal domain" } ] }
// Error - No Body
PATCH/rest/sharedMailboxes

Update current user's shared mailbox active status

Description:

Updates the active status of one or more shared mailboxes for the current user.

Precondition:

The user must be authenticated and belong to an internal domain.

Response:

The updated list of shared mailboxes is returned.
Request Body
data
Required
SharedMailboxMemberStatusPatchRequest[]

List of shared mailbox status updates to apply.

Responses

The shared mailbox status is updated successfully.

id
string
active
boolean

Indicates whether the shared mailbox is active.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

total
integer

Total number of items available.

limit
integer

Maximum number of items returned per page.

offset
integer

Number of items skipped before the current page.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_NOT_INTERNAL_DOMAIN

code
string

Error code

message
string

Error message

Unprocessable Content

Possible error codes: ERR_MAX_ACTIVED_SHAREDMAILBOX

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X PATCH \
  "https://{instance}.kiteworks.com/rest/sharedMailboxes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "data": [
         {
         "id": "string",
         "active": true
       }
       ]
       }'
Python
import requests

url = "https://{instance}.kiteworks.com/rest/sharedMailboxes"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}
payload = {
  "data": [
  {
  "id": "string",
  "active": true
}
]
}
response = requests.patch(url, headers=headers, json=payload)
print(response.json())
Responses
{ "data": [ { "id": "string", "active": true, "user": {}, "members": [ "..." ] } ], "metadata": {} }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] }
{ "errors": [ { "code": "ERR_NOT_INTERNAL_DOMAIN", "message": "The email is not internal domain" } ] }
{ "errors": [ { "code": "ERR_MAX_ACTIVED_SHAREDMAILBOX", "message": "Maximum activated shared mailbox reached" } ] }
// Error - No Body
GET/rest/sharedMailboxes/mail/actions/counters

Return current user's shared mailbox counters

Description:

Returns unread message counters for the current user's active shared mailboxes.

Precondition:

The user must be authenticated.

Response:

A list of mail counters for each active shared mailbox is returned.
Parameters
Query Parameters
id:in
Optional
string[]

Comma-separated list of shared mailbox user IDs to filter by. (Recommended request size <= 100)

Responses

The shared mailbox counters are returned successfully.

id
string
draft
integer

Number of draft emails.

inbox
integer

Number of emails in the inbox.

inboxUnread
integer

Number of unread emails in the inbox.

outgoing
integer

Number of outgoing emails.

outgoingError
integer

Number of outgoing emails that encountered an error.

outgoingQueued
integer

Number of outgoing emails queued for sending.

outgoingTransferring
integer

Number of outgoing emails currently being transferred.

outgoingTransferringIds
string[]
trash
integer

Number of emails in the trash.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_ACCESS_USER

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/sharedMailboxes/mail/actions/counters" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

url = "https://{instance}.kiteworks.com/rest/sharedMailboxes/mail/actions/counters"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "data": [ { "id": "string", "counters": {} } ] }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] }
// Error - No Body
GET/rest/sharedMailboxes/{id}/settings

Return shared mailbox settings

Description:

Returns the application settings for the specified shared mailbox.

Precondition:

The user must be authenticated and the specified shared mailbox must be active.

Response:

The shared mailbox settings are returned.
Parameters
Path Parameters
id
Required
string

The unique identifier (UUID) of the user.

Responses

The shared mailbox settings are returned successfully.

fileFilterExclusionGroups
string[]

List of file type groups excluded from upload.

linkExpiry
boolean

Indicates whether link expiry is enabled for sent files.

ACL
integer

Access control level applied to sent files.

ACL
string[]

List of access control levels available for the shared mailbox.

maxLinkExpiration
integer

Maximum link expiration period in days allowed by policy.

returnReceiptDefault
boolean

Indicates whether return receipts are requested by default.

zipLimit
integer

Maximum number of files that can be included in a single ZIP download.

sendFileLimit
integer

Maximum number of files that can be sent in a single email.

selfCopy
string

Policy for sending a copy of outgoing emails to the sender.

defaultLinkExpiry
integer

Default link expiration period in days.

aclDefault
string

Default access control level applied to new files.

fileFilterCustomFileTypes
string[]

List of custom file extensions excluded from upload.

watermarkEnabled
boolean

Indicates whether document watermarking is enabled.

returnReceipt
string

Policy for requesting read receipts on sent emails.

mailExpirationNotification
string

Policy for sending email expiration notifications.

includeFingerprintDefault
boolean

Indicates whether fingerprint inclusion is enabled by default.

includeFingerprint
string

Policy for including a digital fingerprint in sent emails.

secureMessageBody
string

Policy for securing the message body in outgoing emails.

selfCopyDefault
boolean

Indicates whether self-copy is enabled by default.

allowedFileExtensions
string[]

List of file extensions explicitly allowed for upload.

excludedFileExtensions
string[]

List of file extensions blocked from upload.

secureMessageBodyDefault
boolean

Indicates whether secure message body is enabled by default.

watermarkPreview
string

Watermark text or template applied to file previews.

sendExternal
boolean

Indicates whether users can send files to external recipients.

defaultForm
string

Identifier of the default web form associated with the shared mailbox.

defaultCountryCode
string

Default country code used for phone number formatting.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_ACCESS_USER

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/sharedMailboxes/:id/settings" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

id = "VALUE"  # The unique identifier (UUID) of the user.

url = f"https://{{instance}}.kiteworks.com/rest/sharedMailboxes/{id}/settings"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "fileFilterExclusionGroups": [ "string" ], "sendOptionEnabled": {}, "ACL": [ "string" ], "maxLinkExpiration": 1, "returnReceiptDefault": true, "zipLimit": 1 }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] }
// Error - No Body
GET/rest/sharedMailboxes/{id}/webForms

List web forms available to a shared mailbox

Description:

Returns a list of web forms available to the specified shared mailbox.

Precondition:

The user must be authenticated and the specified shared mailbox must be active.

Response:

A list of web forms is returned.
Parameters
Path Parameters
id
Required
string

The unique identifier (UUID) of the user.

Query Parameters
returnEntity
Optional
boolean

If true, includes the entity in the response body.

with
Optional
string

Specifies additional fields to include in the response.

mode
Optional
string

Determines the detail level of the response body.

Responses

The web forms are returned successfully.

id
string

Unique identifier of the web form.

lastModified
string

Date and time when the web form was last modified.

name
string

Display name of the web form.

description
string

Description of the web form.

url
string

URL where the web form is accessible.

enabled
boolean

Indicates whether the web form is active.

authRequired
boolean

Indicates whether authentication is required to submit the web form.

embedded
boolean

Indicates whether the web form can be embedded in external pages.

standalone
boolean

Indicates whether the web form can be used as a standalone page.

webFormId
string

Unique identifier of the web form.

profileId
integer

Unique identifier of the user profile associated with the web form.

id
string

Unique identifier of the web form field.

sequence
integer

Display order of the field within the form.

label
string

Display label of the field.

type
string

Input type of the field (e.g., text, select, checkbox).

specialType
string

Special processing type for the field, if applicable.

placeholder
string

Placeholder text shown in the field before input.

defaultValue
string

Default value pre-populated in the field.

optionValues
string

Available option values for select-type fields.

mandatory
boolean

Indicates whether the field is required.

editable
boolean

Indicates whether the field can be edited by the user.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_ACCESS_USER

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/sharedMailboxes/:id/webForms" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

id = "VALUE"  # The unique identifier (UUID) of the user.

url = f"https://{{instance}}.kiteworks.com/rest/sharedMailboxes/{id}/webForms"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "data": [ { "id": "string", "lastModified": "2024-01-15", "name": "string", "description": "string", "url": "string", "enabled": true } ] }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] }
// Error - No Body
GET/rest/admin/sharedMailboxes

Return shared mailbox list

Description:

Returns a paginated list of shared mailboxes, optionally filtered by user IDs.

Precondition:

Caller must have system, application, or helpdesk admin role.

Response:

A list of shared mailboxes is returned.
Parameters
Query Parameters
orderBy
Optional
string

Sort order for the results.
modified:asc – Sort by last modified date, ascending.
modified:desc – Sort by last modified date, descending.
active:asc – Sort by active status, ascending.
active:desc – Sort by active status, descending.

limit
Optional
integer

Maximum number of results to return.

offset
Optional
integer

Number of results to skip before returning, for pagination.

active
Optional
boolean

Filter by active status. If true, returns only active shared mailboxes; if false, returns only inactive ones.

id:in
Optional
string[]

Comma-separated list of shared mailbox user UUIDs to filter by. (Recommended request size <= 100)

Responses

The shared mailboxes have been successfully returned.

id
string
active
boolean

Indicates whether the shared mailbox is active.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

total
integer

Total number of items available.

limit
integer

Maximum number of items returned per page.

offset
integer

Number of items skipped before the current page.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/admin/sharedMailboxes" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

url = "https://{instance}.kiteworks.com/rest/admin/sharedMailboxes"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
{ "data": [ { "id": "string", "active": true, "user": {}, "members": [ "..." ] } ], "metadata": {} }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
// Error - No Body
POST/rest/admin/sharedMailboxes

Create a shared mailbox

Description:

Converts the specified user account into a shared mailbox and assigns the specified members.

Precondition:

Caller must have system, application, or helpdesk admin role.

Response:

The shared mailbox is created and its details are returned.
Request Body
userId
Required
string

The UUID of the user to convert into a shared mailbox.

memberIds
Required
string[]

List of member UUIDs to add to the shared mailbox. (Recommended request size <= 100)

remoteWipe
boolean

If true, remotely wipes all devices associated with the user being converted.

deleteUnsharedData
boolean

If true, deletes any data that is not shared with other users after conversion.

retainData
boolean

If true, retains the user's data and transfers it to the specified retainToUser.

retainToUser
string

The UUID of the user who will receive the retained data.

retainPermissionToSharedData
boolean

If true, the retainToUser will also receive permissions to the shared data.

retainToAdvancedFormUser
string

The UUID of an alternate user for advanced data retention scenarios.

Responses

The shared mailbox has been created successfully.

id
string
active
boolean

Indicates whether the shared mailbox is active.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_ACCESS_ADMIN, ERR_ACCESS_USER, ERR_ADMIN_ROLE_RANK_RESTRICTED, ERR_NOT_INTERNAL_DOMAIN

code
string

Error code

message
string

Error message

Content Too Large

Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE

code
string

Error code

message
string

Error message

Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER, ERR_CANNOT_RETAIN_DATA_TO_THE_SAME_USER, ERR_USER_IS_NOT_INTERNAL_DL_OR_INTERNAL_ACCOUNT, ERR_CANNOT_RETAIN_DATA_TO_UNVERIFIED_USER

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X POST \
  "https://{instance}.kiteworks.com/rest/admin/sharedMailboxes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "userId": "string",
         "memberIds": [
         "string"
       ],
         "remoteWipe": true,
         "deleteUnsharedData": true,
         "retainData": true,
         "retainToUser": "string"
       }'
Python
import requests

url = "https://{instance}.kiteworks.com/rest/admin/sharedMailboxes"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}
payload = {
  "userId": "string",
  "memberIds": [
  "string"
],
  "remoteWipe": true,
  "deleteUnsharedData": true,
  "retainData": true,
  "retainToUser": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
Responses
{ "id": "string", "active": true, "user": {}, "members": [ { "id": "string", "email": "string", "name": "string", "profileIcon": "string" } ] }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_ACCESS_ADMIN", "message": "Insufficient admin access permissions" } ] }
{ "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] }
{ "errors": [ { "code": "ERR_ADMIN_ROLE_RANK_RESTRICTED", "message": "Action is restricted due to admin role rank" } ] }
{ "errors": [ { "code": "ERR_NOT_INTERNAL_DOMAIN", "message": "The email is not internal domain" } ] }
{ "errors": [ { "code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE", "message": "Folder owner's remaining storage quota does not permit for a file upload of this size." } ] }
{ "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] }
{ "errors": [ { "code": "ERR_CANNOT_RETAIN_DATA_TO_THE_SAME_USER", "message": "Cannot retain data: selected user is being deleted/demoted. Please choose a different user." } ] }
{ "errors": [ { "code": "ERR_USER_IS_NOT_INTERNAL_DL_OR_INTERNAL_ACCOUNT", "message": "User is not internal distribution list or internal domain" } ] }
{ "errors": [ { "code": "ERR_CANNOT_RETAIN_DATA_TO_UNVERIFIED_USER", "message": "Cannot retain data: selected user is unverified. Please select a verified user before proceeding." } ] }
// Error - No Body
DELETE/rest/admin/sharedMailboxes

Delete shared mailboxes

Description:

Deletes the specified shared mailboxes and restores the associated user accounts.

Precondition:

Caller must have system, application, or helpdesk admin role.

Response:

The shared mailboxes are deleted successfully.
Parameters
Query Parameters
id:in
Optional
string[]

Comma-separated list of shared mailbox user UUIDs to delete. (Recommended request size <= 100)

Responses

The shared mailboxes have been deleted successfully.

Empty response body.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED, ERR_ENTITY_NOT_FOUND

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_ACCESS_ADMIN, ERR_ACCESS_USER, ERR_ADMIN_ROLE_RANK_RESTRICTED, ERR_LICENSE_MAX_USERS_COUNT_REACHED

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X DELETE \
  "https://{instance}.kiteworks.com/rest/admin/sharedMailboxes" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

url = "https://{instance}.kiteworks.com/rest/admin/sharedMailboxes"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())
Responses
// Request successful - No Body
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_ENTITY_NOT_FOUND", "message": "Entity does not exist" } ] }
{ "errors": [ { "code": "ERR_ACCESS_ADMIN", "message": "Insufficient admin access permissions" } ] }
{ "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] }
{ "errors": [ { "code": "ERR_ADMIN_ROLE_RANK_RESTRICTED", "message": "Action is restricted due to admin role rank" } ] }
{ "errors": [ { "code": "ERR_LICENSE_MAX_USERS_COUNT_REACHED", "message": "License count has been reached" } ] }
// Error - No Body
PATCH/rest/admin/sharedMailboxes/{id}

Update shared mailbox members

Description:

Updates the member list of the specified shared mailbox.

Precondition:

Caller must have system, application, or helpdesk admin role.

Response:

The shared mailbox is updated and its details are returned.
Parameters
Path Parameters
id
Required
string

The unique identifier (UUID) of the user.

Request Body
memberIds
Required
string[]

List of member ids (Recommended request size <= 100)

Responses

The shared mailbox has been updated successfully.

id
string
active
boolean

Indicates whether the shared mailbox is active.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

id
string

Unique identifier (UUID) for the user.

email
string

Email address associated with the user.

name
string

Full name of the user.

profileIcon
string

URL or identifier for the user's profile icon.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

code
string

Error code

message
string

Error message

Forbidden

Possible error codes: ERR_ACCESS_ADMIN, ERR_ACCESS_USER, ERR_ADMIN_ROLE_RANK_RESTRICTED, ERR_NOT_INTERNAL_DOMAIN

code
string

Error code

message
string

Error message

Request blocked by WAF

Empty response body.
Shell
curl -X PATCH \
  "https://{instance}.kiteworks.com/rest/admin/sharedMailboxes/:id" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "memberIds": [
         "string"
       ]
       }'
Python
import requests

id = "VALUE"  # The unique identifier (UUID) of the user.

url = f"https://{{instance}}.kiteworks.com/rest/admin/sharedMailboxes/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}
payload = {
  "memberIds": [
  "string"
]
}
response = requests.patch(url, headers=headers, json=payload)
print(response.json())
Responses
{ "id": "string", "active": true, "user": {}, "members": [ { "id": "string", "email": "string", "name": "string", "profileIcon": "string" } ] }
{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }
{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }
{ "errors": [ { "code": "ERR_ACCESS_ADMIN", "message": "Insufficient admin access permissions" } ] }
{ "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] }
{ "errors": [ { "code": "ERR_ADMIN_ROLE_RANK_RESTRICTED", "message": "Action is restricted due to admin role rank" } ] }
{ "errors": [ { "code": "ERR_NOT_INTERNAL_DOMAIN", "message": "The email is not internal domain" } ] }
// Error - No Body
Previoussettings
NextshortLinks