Skip to content
Optiwork API Docs

Snooze conversations

POST
/mail/mailboxes/{mailbox}/snooze
curl --request POST \
  --url https://mail.work.optidata.cloud/api/mail/mailboxes/78/snooze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "conversation_ids": [ "4185" ], "until": "2026-08-20 08:00:00", "timezone": "America/Sao_Paulo", "folder_id": "2" }'

Hide threads until until, remembering folder_id so they can be put back where they came from when they wake. The moment is read in the timezone you send and must be in the future.

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.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
conversation_ids
required

Threads to snooze. Up to 100.

Array<string>
<= 100 items
until
required

When the threads should come back.

string
timezone
required

IANA time zone the moment is expressed in.

string
folder_id
required

The folder the threads are being taken out of.

string
Examples
Exampletomorrow
{
  "conversation_ids": [
    "4185"
  ],
  "until": "2026-08-20 08:00:00",
  "timezone": "America/Sao_Paulo",
  "folder_id": "2"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The operation succeeded.

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

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