Decline a requested read receipt

POST

/mail/mailboxes/{mailbox}/messages/{messageId}/read-receipt/reject

const url = 'https://mail.work.optidata.cloud/api/mail/mailboxes/78/messages/4186/read-receipt/reject';
const options = {method: 'POST', 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 POST \
  --url https://mail.work.optidata.cloud/api/mail/mailboxes/78/messages/4186/read-receipt/reject \
  --header 'Authorization: Bearer <token>'

Decline the read-receipt the sender asked for. The sender is not notified that the message was opened.

Authorizations

bearerAuth

Parameters

Path Parameters

mailbox

required

integer

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

messageId

required

string

Id of the message.

Responses

200

The operation succeeded. The body is an empty JSON array ([]) — these endpoints acknowledge success with no payload.

application/json

Array

Examples

[]

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

The caller may not act on this mailbox, user or resource.

application/json

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

object

message

required

Human-readable description of the failure.

string

Examples

denied

{
  "message": "This action is unauthorized."
}

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

502

The mail platform did not answer as expected — a folder or message that does not exist, or a transient failure. reference is the code to quote to support and fault_code names the underlying condition. A 503 with the same envelope means the platform is in maintenance; retry shortly.

application/json

Failure raised by the mail platform behind the API rather than by the request itself.

object

error

required

What went wrong, phrased for the end user.

string

status

required

Repeats the HTTP status code.

integer

help

required

Suggested next step.

string

reference

required

Support reference, e.g. MZ-502.

string

fault_code

Names the underlying condition, e.g. mail.NO_SUCH_FOLDER.

string | null

Examples

Unknown folder

{
  "error": "The mail server did not answer as expected, so this action could not be completed.",
  "status": 502,
  "help": "If the problem persists, contact support and inform the error code above.",
  "reference": "MZ-502",
  "fault_code": "mail.NO_SUCH_FOLDER"
}

Unknown message

{
  "error": "The mail server did not answer as expected, so this action could not be completed.",
  "status": 502,
  "help": "If the problem persists, contact support and inform the error code above.",
  "reference": "MZ-502",
  "fault_code": "mail.NO_SUCH_MSG"
}