Templates: Edição

Excluir template

Remove um template html e todas as suas versões.

POSThttps://g.sendcorex.com/v1/templatecommand: delete_template
i

Requer o escopo template:delete na sua API key.

i

Até 30 chamadas por minuto por conta. Acima disso, o comando responde RATE_LIMITED.

!

Isso não pode ser desfeito. Campanhas e emails já enviados mantêm sua própria cópia do conteúdo e não são afetados.

i

Templates Unlayer e Custom são excluídos no dashboard.

Argumentos

  • template_idstringobrigatório

    Um template html.

    ex.: "html_5f2c8a10-3d4e-4b6f-9a71-2c8e0d4b7a93"

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/template',
  {
    commands: [
      {
        command: "delete_template",
        args: {
          template_id: "html_5f2c8a10-3d4e-4b6f-9a71-2c8e0d4b7a93"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

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": "delete_template",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "template_id": "html_5f2c8a10-3d4e-4b6f-9a71-2c8e0d4b7a93",
        "deleted": true
      }
    }
  ]
}

Campos da resposta

  • template_id

    O template que foi removido.

  • deleted

    Sempre true.

Erros

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

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 simultâneas para o mesmo IP + API key. Aguarde o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o escopo de que este comando precisa.

  • CMDINVALID_ARGS

    Um argumento é inválido: um `template_id` malformado, `name` ou `html` ausente, um nome com mais de 255 caracteres, um `version_at` que não é RFC 3339…

  • CMDTEMPLATE_NOT_FOUND

    O template não está na sua conta.

  • CMDTEMPLATE_READ_ONLY

    Um template Unlayer ou Custom: edite-o no editor do dashboard. Só templates html mudam pela API.

  • CMDRATE_LIMITED

    Este comando foi chamado vezes demais no último minuto pela sua conta. Aguarde um minuto.

  • CMDINTERNAL

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