Templates : Édition

Supprimer un template

Supprime un template html et toutes ses versions.

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

Nécessite le scope template:delete sur votre API key.

i

Jusqu'à 30 appels par minute et par compte. Au-delà, la commande répond RATE_LIMITED.

!

Cette action est irréversible. Les campagnes et e-mails déjà envoyés conservent leur propre copie du contenu et ne sont pas affectés.

i

Les templates Unlayer et Custom se suppriment dans le dashboard.

Arguments

  • template_idstringobligatoire

    Un template html.

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

Démarrage rapide

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);

Réponse

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "delete_template",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "template_id": "html_5f2c8a10-3d4e-4b6f-9a71-2c8e0d4b7a93",
        "deleted": true
      }
    }
  ]
}

Champs de la réponse

  • template_id

    Le template supprimé.

  • deleted

    Toujours true.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou a été désactivée dans le dashboard.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDMISSING_SCOPE

    L'API key n'a pas le scope dont cette commande a besoin.

  • CMDINVALID_ARGS

    Un argument est invalide : un `template_id` mal formé, un `name` ou un `html` manquant, un nom de plus de 255 caractères, un `version_at` qui n'est pas au format RFC 3339…

  • CMDTEMPLATE_NOT_FOUND

    Le template n'existe pas dans votre compte.

  • CMDTEMPLATE_READ_ONLY

    Un template Unlayer ou Custom : modifiez-le dans l'éditeur du dashboard. Seuls les templates html se modifient via l'API.

  • CMDRATE_LIMITED

    Votre compte a appelé cette commande trop de fois au cours de la dernière minute. Attendez une minute.

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.