Get Mail preferences

GET

/api/v1/mail/preferences

const url = 'https://example.com/api/v1/mail/preferences';
const options = {method: 'GET', 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 GET \
  --url https://example.com/api/v1/mail/preferences \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User. It returns when Mail marks a Message as read: when it opens, after one second, or after a manual action. Route: /api/v1/mail/preferences. Inputs: . Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Responses

200

application/json

object

load_remote_content

required

boolean

read_marking

required

string

Allowed values: on_open after_one_second manually

Example

{
  "read_marking": "on_open"
}

401

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"
  }
}

403

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"
  }
}