Skip to content
Optiwork API Docs

Check whether conversations are snoozed

GET
/mail/mailboxes/{mailbox}/snooze
curl --request GET \
  --url 'https://mail.work.optidata.cloud/api/mail/mailboxes/78/snooze?conversation_ids%5B%5D=4185&conversation_ids%5B%5D=4182' \
  --header 'Authorization: Bearer <token>'

Look up the snooze records of specific threads — what a listing does to decide which rows should show a snooze badge. Threads with no snooze simply do not appear in the answer.

Requires snooze to be enabled for the tenant.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
mailbox
required
integer

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

Query Parameters

Section titled “Query Parameters”
conversation_ids[]
required
Array<string>
<= 100 items

Ids of the threads to check. Up to 100. Repeat the parameter once per thread (conversation_ids[]=4185&conversation_ids[]=4182).

Responses

Section titled “ Responses ”

200

Section titled “200”

The snooze records found.

Media typeapplication/json
Array<object>

A conversation hidden until a chosen moment.

object
id
integer
mailbox_id
integer
conversation_id
string
original_folder_id

The folder to restore the thread to.

string | null
snooze_until

When the thread comes back.

string
timezone
string
snooze_hash

Stable identifier of the snooze record.

string
unsnoozed_at

When the thread actually came back, if it already has.

string | null
unsnoozed_target_folder_id

The folder the thread was restored to, once it woke.

string | integer | null
was_auto_unsnoozed

Whether the thread woke on its own (its time came) rather than by hand.

boolean
created_at
string
updated_at
string
returns_in_human

Human-readable time until the thread returns, e.g. Returns in 4 days.

string | null
returned_ago_human

Human-readable time since the thread returned, when it already has.

string | null
Examples
Examplenone

No snoozed thread among those asked for

[]

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

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

403

Section titled “403”

Snooze is not enabled for this tenant.

Media typeapplication/json

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

object
message
required

Human-readable description of the failure.

string
Examples
Exampledisabled
{
  "message": "Not available"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The conversations field is required.",
  "errors": {
    "conversation_ids": [
      "The conversations field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

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

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}