How many conversations just woke up

GET

/mail/mailboxes/{mailbox}/snooze/recent/items

const url = 'https://mail.work.optidata.cloud/api/mail/mailboxes/78/snooze/recent/items?folder_id=2';
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://mail.work.optidata.cloud/api/mail/mailboxes/78/snooze/recent/items?folder_id=2' \
  --header 'Authorization: Bearer <token>'

The same set as the previous operation, reported as a count. items carries the pre-rendered list rows the mail web client uses; a programmatic caller should read count and get the thread data from the listing endpoints.

Requires snooze to be enabled for the tenant.

Authorizations

bearerAuth

Parameters

Path Parameters

mailbox

required

integer

Id of the mailbox. Every mailbox the caller may use is listed in their account.

Query Parameters

folder_id

required

string

The folder to look at.

Responses

200

The count of recently woken threads.

application/json

object

items

required

Pre-rendered list rows, for the web client.

Array<string>

count

required

integer

Examples

two

{
  "items": [],
  "count": 0
}

401

Missing, malformed or expired authentication key.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Snooze is not enabled for this tenant.

application/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

disabled

{
  "message": "Not available"
}

422

The request body or query string failed validation.

application/json

object

message

required

The first validation message.

string

errors

required

Validation messages keyed by field name.

object

key

additional properties

Array<string>

Examples

invalid

{
  "message": "The conversations field is required.",
  "errors": {
    "conversation_ids": [
      "The conversations field is required."
    ]
  }
}

429

Rate limit exceeded. Retry after the window resets.

application/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

throttled

{
  "message": "Too Many Attempts."
}