Move a message

POST/api/v1/mailbox/messages/{message_id}/move
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Moves the message to another folder. Its id changes (a new folder and uid): use the id in the answer from now on.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.
400 No folder by that name, or the message is already there.
404 Message not found.

Parameters

NameInTypeDescription
message_idrequiredpathstring

Request body

  • folderstringrequired

    The folder to move it to (its name).

Request

POST/api/v1/mailbox/messages/{message_id}/move
curl -X POST 'https://courier.mailyte.com/api/v1/mailbox/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V/move' \
  -H 'Authorization: Bearer MAILBOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "folder": "Clients"
  }'

Response

Successful Response

  • dataobject
    • idstring

      The message's new id.

200application/json
{
  "type": "success",
  "msg": "Message moved",
  "data": {
    "id": "Clients:88"
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
400No folder by that name, or the message is already there.
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.
404Message not found.
422Validation Error

Every status, with what causes it and what to do, is on the error reference.