Receber e-mails: Regras

Atualizar regra

Substitua as condições, exceções e ações de uma regra. A posição e a contagem de hits continuam.

POSThttps://g.sendcorex.com/v1command: update_rule
i

Envie a regra inteira, com os mesmos campos de Criar regra. Campos ausentes não são mantidos da versão antiga.

Argumentos

  • idstringobrigatório

    O rule_id.

  • namestringobrigatório

    Até 80 caracteres.

  • conditionsobject[]obrigatório

    Veja Criar regra.

  • actionsobject[]obrigatório

    Veja Criar regra.

  • matchstringopcional

    all ou any.

  • exceptobject[]opcional

    Exceções.

  • stopbooleanopcional

    Para o processamento.

  • enabledbooleanopcional

    Ligada ou desligada.

  • timezonestringopcional

    Fuso horário IANA.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "update_rule",
        args: {
          id: "Vj0xUlVMRTAx",
          name: "Clients always in Inbox",
          match: "all",
          conditions: [
            {
              field: "from_domain",
              op: "in_list",
              value: "acme.com, globex.com"
            },
            {
              field: "provider",
              op: "is_any_of",
              value: [
                "microsoft_365",
                "google_workspace"
              ]
            }
          ],
          except: [
            {
              field: "subject",
              op: "contains",
              value: "newsletter"
            }
          ],
          actions: [
            {
              type: "keep_inbox"
            },
            {
              type: "label",
              value: "Clients"
            },
            {
              type: "star"
            }
          ],
          stop: false,
          timezone: "Asia/Kuala_Lumpur"
        }
      }
    ]
  },
  { 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);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "update_rule",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "id": "Vj0xUlVMRTAx",
        "rule_id": "Vj0xUlVMRTAx",
        "name": "Clients always in Inbox",
        "match": "all",
        "conditions": [
          {
            "field": "from_domain",
            "op": "in_list",
            "value": "acme.com, globex.com"
          },
          {
            "field": "provider",
            "op": "is_any_of",
            "value": [
              "microsoft_365",
              "google_workspace"
            ]
          }
        ],
        "except": [
          {
            "field": "subject",
            "op": "contains",
            "value": "newsletter"
          }
        ],
        "actions": [
          {
            "type": "keep_inbox"
          },
          {
            "type": "label",
            "value": "Clients"
          },
          {
            "type": "star"
          }
        ],
        "stop": false,
        "timezone": "Asia/Kuala_Lumpur",
        "enabled": true,
        "position": 0,
        "hits": 128,
        "last_hit_at": "2026-10-25T09:12:44Z",
        "created_at": "2026-10-01T02:00:00Z",
        "updated_at": "2026-10-20T08:30:00Z"
      }
    }
  ]
}

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINVALID_ARGS

    Um argumento obrigatório está ausente ou é inválido.

  • CMDINVALID_RULE

    A regra não é válida. A mensagem diz qual condição ou ação e por quê.

  • CMDNOT_FOUND

    A mensagem, conversa ou pasta não existe para este token.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.