markEmails

Ставит или снимает три привычные отметки — «прочитано», «флажок» и «отвечено» — у одного письма или у 500 сразу. Отметки видны в почтовых программах сотрудников. Любые флаги и свои ключевые слова — setEmailFlags.

Параметры

Нужна хотя бы одна из отметок seen, flagged, answered. Не указанная отметка не меняется.

Пример запроса

Два письма Марии — прочитаны:

curl

curl -X POST "$GRATIO_URL/v1/instances/$GRATIO_ID/markEmails" \
  -H "Authorization: Bearer $GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "idMessages": [
      "c62b698304229a98aad3",
      "7877cd439c05bc16617b"
    ],
    "seen": true
  }'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/v1/instances/{os.environ['GRATIO_ID']}"
HEADERS = {"Authorization": f"Bearer {os.environ['GRATIO_TOKEN']}"}

url = f"{BASE}/markEmails"
payload = {
    "idMessages": ["c62b698304229a98aad3", "7877cd439c05bc16617b"],
    "seen": True,
}
response = requests.post(url, json=payload, headers=HEADERS, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/v1/instances/${GRATIO_ID}`;
const auth = { Authorization: `Bearer ${GRATIO_TOKEN}` };

const url = `${base}/markEmails`;
const payload = {
  idMessages: ["c62b698304229a98aad3", "7877cd439c05bc16617b"],
  seen: true,
};
const response = await fetch(url, {
  method: "POST",
  headers: { ...auth, "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/v1/instances/' . getenv('GRATIO_ID');
$auth = 'Authorization: Bearer ' . getenv('GRATIO_TOKEN');
$url = $base . '/markEmails';
$payload = [
    'idMessages' => ['c62b698304229a98aad3', '7877cd439c05bc16617b'],
    'seen' => true,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [$auth, 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK:

{"updated": 2}

Поля ответа

Ещё примеры

Флажок и непрочитано

Вернуть письмо в работу — снять «прочитано» и поставить флажок:

curl -X POST "$GRATIO_URL/v1/instances/$GRATIO_ID/markEmails" \
  -H "Authorization: Bearer $GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "folder": "inbox",
    "uids": [
      1540
    ],
    "seen": false,
    "flagged": true
  }'

Ошибки

Общие правила — в статье Ответы и ошибки.

Что дальше

• setEmailFlags — любые флаги и свои ключевые слова.
• readChat — все непрочитанные письма собеседника разом.
• searchEmails — найти письма с отметками или без.