Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kiteworks sharedMailbox API

The sharedMailbox API from Kiteworks — 6 operation(s) for sharedmailbox.

Kiteworks sharedMailbox API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include sharedMailbox. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 6 paths, and defines 19 schemas. It is described by OpenAPI 3.0.2, at version 28.

Requests are made against the base URL https://your.kiteworks.domain/rest.

9 operations 6 paths 19 schemas 1 DELETE5 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

sharedMailbox 9
PATCH
/rest/sharedMailboxes
Update current user's shared mailbox active status
body → 200401403422490
GET
/rest/sharedMailboxes
Return current user's shared mailboxes
5 params → 200401403490
GET
/rest/sharedMailboxes/mail/actions/counters
Return current user's shared mailbox counters
1 param → 200401403490
GET
/rest/sharedMailboxes/{id}/settings
Return shared mailbox settings
1 param → 200401403490
GET
/rest/sharedMailboxes/{id}/webForms
List web forms available to a shared mailbox
4 params → 200401403490
POST
/rest/admin/sharedMailboxes
Create a shared mailbox
body → 201401403413422490
GET
/rest/admin/sharedMailboxes
Return shared mailbox list
5 params → 200401490
DELETE
/rest/admin/sharedMailboxes
Delete shared mailboxes
1 param → 204401403490
PATCH
/rest/admin/sharedMailboxes/{id}
Update shared mailbox members
1 param body → 200401403490

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are SharedMailboxSetting (25 properties), WebForm (11 properties), WebFormField (10 properties), MailCounters (9 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
SharedMailboxSetting
object
25 properties
WebForm
object
11 properties
SharedMailboxMemberStatusPatchRequest
object
2 properties 2 required
MetaData
object
3 properties
WebFormProfile
object
2 properties
UserBasic
object
4 properties
SharedMailboxStatusPatchRequest
object
1 property 1 required
WebFormField
object
10 properties
MailIdCounters
object
2 properties
SharedMailboxList
object
2 properties
SendOption
object
2 properties
MailCountersList
object
1 property
SharedMailbox
object
4 properties
Error
object
2 properties
MailCounters
object
9 properties
WebFormList
object
1 property
SharedMailboxPostRequest
object
8 properties 2 required
SharedMailboxPatchRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-sharedmailbox-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API