Start a Mail sync

POST

/api/v1/mail/accounts/{id}/sync

const url = 'https://example.com/api/v1/mail/accounts/example/sync';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/mail/accounts/example/sync \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User. It queues a sync for the account and returns when the request is accepted. It returns 400 when the account is disabled or 404 when it is missing. Route: /api/v1/mail/accounts/{id}/sync. Inputs: id. Do not automatically replay this operation after an uncertain result.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

required

string

Responses

202

404

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}