TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

GET api/2.0/mail/operations/{operationId} This function requires authentication

Description

Returns a status of the mail operation with the ID specified in the request.

Parameters
Name Description Type Example
operationId
sent in url
Operation ID string some text
Example
GET api/2.0/mail/operations/%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Mail operation status

Example Response

application/json

{
  "status": 0,
  "response": {
    "Completed": true,
    "Id": "Id",
    "Status": "Status",
    "Error": "Error",
    "Percents": 100,
    "Source": "Source",
    "OperationType": 1,
    "Operation": "Operation"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Completed>True</Completed>
    <Id>Id</Id>
    <Status>Status</Status>
    <Error>Error</Error>
    <Percents>100</Percents>
    <Source>Source</Source>
    <OperationType>1</OperationType>
    <Operation>Operation</Operation>
  </response>
</result>