Skip to content

Wake conversations up now

DELETE
/mail/mailboxes/{mailbox}/snooze
curl --request DELETE \
--url https://mail.work.optidata.cloud/api/mail/mailboxes/78/snooze \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "conversation_ids": [ "4185" ] }'

End the snooze immediately and restore the threads to the folder they were taken from.

Requires snooze to be enabled for the tenant.

mailbox
required
integer

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

Media typeapplication/json
object
conversation_ids
required

Ids of the threads to act on.

Array<string>
>= 1 items
Examples
Examplewake
{
"conversation_ids": [
"4185"
]
}

The operation succeeded.

Media typeapplication/json
object
success
boolean
Examples
Exampleok
{
"success": true
}

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

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

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

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