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 mail API

The mail API from Kiteworks — 29 operation(s) for mail.

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

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

This API exposes 32 operations across 29 paths, and defines 39 schemas. It is described by OpenAPI 3.0.2, at version 28.

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

32 operations 29 paths 39 schemas 4 DELETE16 GET5 PATCH5 POST2 PUT

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 32

Across 29 paths, the API surfaces 32 operations — 4 DELETE, 16 GET, 5 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

mail 32
GET
/rest/mail
Get messages in mail folders
35 params → 200490
DELETE
/rest/mail
Delete draft messages
2 params → 204207401403490
GET
/rest/mail/actions/counters
Get message counts for mail folders
1 param → 200401490
PATCH
/rest/mail/actions/deletePermanent
Permanently delete messages
2 params → 200207401403410490
GET
/rest/mail/actions/distributionList
Expand a distribution list
3 params → 200403490
PATCH
/rest/mail/actions/read
Mark messages as read
2 params → 200207401403490
PATCH
/rest/mail/actions/recover
Recover deleted messages
2 params → 200207401403410490
POST
/rest/mail/actions/sendFile
Send files
3 params body → 201401403422490
PATCH
/rest/mail/actions/trash
Move messages to Trash
2 params → 200207401403490
PATCH
/rest/mail/actions/unread
Mark messages as unread
2 params → 200207401403490
GET
/rest/mail/{emailId}/attachments/actions/zip
Download email attachments in ZIP format
7 params → 200403490
GET
/rest/mail/{emailId}/attachments/actions/zipStatus
Get email attachment security status
4 params → 200403490
GET
/rest/mail/{emailId}/attachments/report
Get email attachment download report
1 param → 200403490
GET
/rest/mail/{emailId}/attachments/reportCsv
Export email attachment download report as CSV
1 param → 200403490
GET
/rest/mail/{emailId}/attachments/{id}/content
Download email attachment
5 params → 200403490
GET
/rest/mail/{emailId}/attachments/{id}/preview
Get email attachment preview metadata
4 params → 200403490
GET
/rest/mail/{id}
Get email metadata
6 params → 200490
DELETE
/rest/mail/{id}
Delete a draft message
1 param → 204401403490
PUT
/rest/mail/{id}/actions/sendFile
Update and send a draft message
4 params body → 200401403422490
GET
/rest/mail/{id}/attachments
Get attachments for an email message
4 params → 200401403490
GET
/rest/mail/{id}/attachments/{attachment_id}
Get an email attachment by attachment ID
3 params → 200401403490
GET
/rest/mail/{id}/packages
Get the package associated with an email
2 params → 200401403490
GET
/rest/mail/{id}/recipients
Get email recipients
9 params → 200401403490
POST
/rest/mail/{id}/actions/withdrawFiles
Withdraw files from a sent message
3 params → 204401403422490
POST
/rest/mail/{id}/actions/copy
Save email attachments to a Kiteworks folder
5 params body → 201401403422490
POST
/rest/mail/{id}/actions/sendTrackingReport
Send tracked activity report for a sent message
4 params → 201401403490
GET
/rest/mail/attachments
Get email attachments sent by the current user
4 params → 200401490
DELETE
/rest/mail/attachments
Withdraw multiple files from messages in Sent and Drafts folders
1 param → 204401422490
POST
/rest/mail/actions/withdraw
Withdraw messages from Sent and Drafts folders
body → 200207401403490
GET
/rest/mail/{id}/scanStatus
Get email message security scan status
1 param → 200401403490
DELETE
/rest/mail/{id}/trackings/me
Remove message tracking access
1 param → 200401403490
PUT
/rest/mail/{id}/settings
Update message tracking access
1 param body → 200401403490

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Mail (45 properties), Mail1 (44 properties), Folder (43 properties). Each schema is shown below with its type and property counts.

MailWithdrawRequest
object
1 property 1 required
Errors
object
1 property
PushedObject
object
4 properties
Tag
object
3 properties
TrackingAccessRecipient
object
6 properties
Preview
object
Class Preview
10 properties
MetaData
object
3 properties
UserBasic
object
4 properties
AttachmentDownloadEvent
object
Represents a single download or interaction event recorded for an email attachment.
8 properties
Attachment
object
19 properties
Recipient
object
5 properties
Mail
object
45 properties
DistributionList
object
Class DistributionList
2 properties 1 required
DestinationFolderIdRequest
object
2 properties 1 required
SendMailSettingPutRequest
object
1 property
UserAttachment
object
10 properties
Permission
object
3 properties
Folder
object
43 properties
ErrorInteger
object
4 properties
MailCounters
object
9 properties
Error
object
2 properties
Role
object
4 properties
File
object
46 properties
DrmFile
object
2 properties
Mail1
object
44 properties
MailAttachments
object
2 properties
MobileInfo
object
5 properties
Fingerprint
object
2 properties
Attachments
object
2 properties
EmailReturnRecipient
object
2 properties
Member
object
14 properties
BulkOperationInteger
object
2 properties
AttachmentDownloadReport
object
Represents the download tracking report for the attachments of a specific email.
3 properties
BaseSendMailPostRequest
object
24 properties
SafeEdit
object
2 properties
Package
object
9 properties
Mails
object
2 properties
Variables
object
2 properties
Group
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-mail-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