POST Agents/EMail/SyncEmailAccount
Some tooltip text!
• 2 minutes to read
• 2 minutes to read
POST /api/v1/Agents/EMail/SyncEmailAccount
Sync the given account, from mail server to SuperOffice database cache.
This API has no throttling, so please be careful with multiple concurrent calls. Mail servers may become angry.
Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| $select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. |
POST /api/v1/Agents/EMail/SyncEmailAccount?$select=name,department,category/id
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: request
SyncUserAccount
| Property Name | Type | Description |
|---|---|---|
| SyncUserAccount | SyncUserAccount | Details for syncing email user accounts |
Response:
No Content
| Response | Description |
|---|---|
| 204 | No Content |
Response body: TimeZoneData
Sample request
POST /api/v1/Agents/EMail/SyncEmailAccount
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8
{
"SyncUserAccount": null
}
Sample response
HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8
null