Set Flags

Arguments

• idsstring[]optional

  Up to 100 message ids.

• idstringoptional

  A single message id. Use this or ids.

• is_readbooleanoptional

  Mark as read (true) or unread (false).

• is_starredbooleanoptional

  Add or remove the star.

• is_importantbooleanoptional

  Add or remove the important flag.

• scopestringoptional

  message (default) or thread. It only affects is_read.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "set_flags",
        args: {
          ids: [
            "Vj0xQUJDMTIz"
          ],
          is_read: true,
          scope: "thread"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Response

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "set_flags",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "items": [
          {
            "id": "Vj0xQUJDMTIz",
            "ok": true,
            "data": {
              "changed": 2
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Response fields

• items[].id

  The id this item refers to.

• items[].ok

  true if the change worked for this id.

• items[].data

  The result for this id. Only when ok is true.

• items[].code / message

  The error for this id. Only when ok is false.

• ok_count / failed_count

  How many ids worked and how many failed.

How the flags behave

• is_read + scope: thread

  Marks the whole conversation.

• is_starred / is_important: true

  Marks only the message of the id.

• is_starred / is_important: false

  Clears the flag in the whole conversation. A conversation row shows "has a star", so unstarring has to clear every message.

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

• 401TOKEN_EXPIRED

  The access token has expired. Call Refresh Token and repeat the request.

• 401INVALID_TOKEN

  The token is malformed, unknown or revoked.

• 429RATE_LIMITED

  More than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.

• CMDINVALID_ARGS

  A required argument is missing or invalid.

• CMDNOT_FOUND

  The message, thread or folder does not exist for this token.

• CMDINTERNAL

  Server error. The detail is only written to the server log.