Modèles

Lister les modèles

Réponses

• 200Une page de modèles, du plus récent au plus ancien, sans le contenu de leurs parties.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string
  objectobligatoire	string	Une valeur parmi : template
  nameobligatoire	string
  aliasobligatoire	string	Peut être null
  default_languageobligatoire	string	Une valeur parmi : en | fr
  partsobligatoire	object	Les parties de chaque langue : la langue par défaut toujours, l’autre quand elle a une partie.
  en	object	Les parties qu’une langue possède.
  emailobligatoire	boolean	Si cette langue a une partie courriel.
  smsobligatoire	boolean	Si cette langue a une partie SMS.
  push	boolean	Si cette langue a une partie push.
  fr	object	Les parties qu’une langue possède.
  emailobligatoire	boolean	Si cette langue a une partie courriel.
  smsobligatoire	boolean	Si cette langue a une partie SMS.
  push	boolean	Si cette langue a une partie push.
  published_versionobligatoire	integer	La version qu’utilisent les envois de production. Null jusqu’à la première publication. Peut être null
  has_unpublished_changesobligatoire	boolean	True quand le brouillon diffère de la version publiée dans une partie ou une langue.
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
  has_moreobligatoire	boolean
  next_cursorobligatoire	string	Passez-le comme cursor pour la page suivante. Null sur la dernière page. Peut être null
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.templates.list({ limit: 20 })
if (error) throw new Error(error.message)
for (const t of data.data) console.log(t.alias, t.published_version)

curl https://api.honkio.ca/v1/templates \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Créer un modèle

Corps de la requête

Réponses

• 201Le modèle, en brouillon.›

  Champ	Type	Description
  idobligatoire	string
  objectobligatoire	string	Une valeur parmi : template
  nameobligatoire	string
  aliasobligatoire	string	Peut être null
  default_languageobligatoire	string	La langue qu’un envoi utilise quand il n’en nomme aucune, et celle dont les parties remplacent une partie qui manque à l’autre langue. Une valeur parmi : en | fr
  variables[]obligatoire	object[]
  keyobligatoire	string
  fallback	string	Utilisée quand un envoi ne fournit aucune valeur. Absente quand la variable n’en a pas.
  from_addressobligatoire	string	L’expéditeur de courriel par défaut. Peut être null
  reply_toobligatoire	string[]
  partsobligatoire	object	Les parties du brouillon par langue : la langue par défaut toujours, l’autre quand elle a une partie.
  en	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  fr	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  published_versionobligatoire	integer	La version qu’utilisent les envois de production. Null jusqu’à la première publication. Peut être null
  has_unpublished_changesobligatoire	boolean	True quand le brouillon diffère de la version publiée dans une partie ou une langue.
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 409EMAIL_TEMPLATE_ALIAS_TAKEN : un autre modèle de ce compte utilise déjà cet alias.Le corps d’erreur standard.
• 422VALIDATION_ERROR (details nomme le champ, comme parts.en.sms.text), EMAIL_TEMPLATE_UNDECLARED_VARIABLE (details.keys) ou TEMPLATE_LIMIT_REACHED (200 modèles par compte, modèles de courriel compris).Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data: template, error } = await honkio.templates.create({
  name: 'Appointment reminder',
  alias: 'appointment-reminder',
  variables: [{ key: 'time' }],
  parts: {
    en: { sms: { text: 'Reminder: your appointment is at {{ time }}.' } },
    fr: { sms: { text: 'Rappel : votre rendez-vous est à {{ time }}.' } },
  },
})
if (error) throw new Error(error.message)
console.log(template.id)

curl -X POST https://api.honkio.ca/v1/templates \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sign-in code",
    "alias": "sign-in-code",
    "variables": [
      {
        "key": "code"
      }
    ],
    "parts": {
      "en": {
        "sms": {
          "text": "Your Acme code is {{ code }}"
        }
      },
      "fr": {
        "sms": {
          "text": "Votre code Acme est {{ code }}"
        }
      }
    }
  }'

Obtenir un modèle par identifiant ou alias

Paramètres

Réponses

• 200Le modèle.›

  Champ	Type	Description
  idobligatoire	string
  objectobligatoire	string	Une valeur parmi : template
  nameobligatoire	string
  aliasobligatoire	string	Peut être null
  default_languageobligatoire	string	La langue qu’un envoi utilise quand il n’en nomme aucune, et celle dont les parties remplacent une partie qui manque à l’autre langue. Une valeur parmi : en | fr
  variables[]obligatoire	object[]
  keyobligatoire	string
  fallback	string	Utilisée quand un envoi ne fournit aucune valeur. Absente quand la variable n’en a pas.
  from_addressobligatoire	string	L’expéditeur de courriel par défaut. Peut être null
  reply_toobligatoire	string[]
  partsobligatoire	object	Les parties du brouillon par langue : la langue par défaut toujours, l’autre quand elle a une partie.
  en	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  fr	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  published_versionobligatoire	integer	La version qu’utilisent les envois de production. Null jusqu’à la première publication. Peut être null
  has_unpublished_changesobligatoire	boolean	True quand le brouillon diffère de la version publiée dans une partie ou une langue.
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

curl https://api.honkio.ca/v1/templates/ID_OR_ALIAS \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Modifier le brouillon d’un modèle

Paramètres

Corps de la requête

Réponses

• 200Le modèle avec son brouillon modifié.›

  Champ	Type	Description
  idobligatoire	string
  objectobligatoire	string	Une valeur parmi : template
  nameobligatoire	string
  aliasobligatoire	string	Peut être null
  default_languageobligatoire	string	La langue qu’un envoi utilise quand il n’en nomme aucune, et celle dont les parties remplacent une partie qui manque à l’autre langue. Une valeur parmi : en | fr
  variables[]obligatoire	object[]
  keyobligatoire	string
  fallback	string	Utilisée quand un envoi ne fournit aucune valeur. Absente quand la variable n’en a pas.
  from_addressobligatoire	string	L’expéditeur de courriel par défaut. Peut être null
  reply_toobligatoire	string[]
  partsobligatoire	object	Les parties du brouillon par langue : la langue par défaut toujours, l’autre quand elle a une partie.
  en	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  fr	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  published_versionobligatoire	integer	La version qu’utilisent les envois de production. Null jusqu’à la première publication. Peut être null
  has_unpublished_changesobligatoire	boolean	True quand le brouillon diffère de la version publiée dans une partie ou une langue.
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED : une clé de test ne peut pas modifier l’alias d’un modèle qui a une version publiée, car des envois de production peuvent utiliser cet alias. Elle peut modifier tous les autres champs du brouillon. Aussi FORBIDDEN lorsque la clé ne dispose pas de la permission requise par cette opération, ou lorsque le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 409EMAIL_TEMPLATE_ALIAS_TAKEN : un autre modèle de ce compte utilise déjà cet alias.Le corps d’erreur standard.
• 422VALIDATION_ERROR (details nomme le champ) ou EMAIL_TEMPLATE_UNDECLARED_VARIABLE (details.keys).Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { error } = await honkio.templates.update('appointment-reminder', {
  parts: { fr: { sms: { text: 'Rappel : rendez-vous à {{ time }}.' } } },
})
if (error) throw new Error(error.message)

curl -X PATCH https://api.honkio.ca/v1/templates/ID_OR_ALIAS \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "parts": {
      "fr": {
        "sms": {
          "text": "Votre code Acme : {{ code }}"
        }
      }
    }
  }'

Supprimer un modèle et ses versions

Paramètres

Réponses

• 204Supprimé, avec ses versions.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED : les modèles n’ont pas de mode test, et cette opération change ce que les envois de production reçoivent. Une clé de test peut créer un modèle, modifier son brouillon et envoyer des courriels de test qui utilisent le brouillon. Aussi FORBIDDEN lorsque la clé ne dispose pas de la permission requise par cette opération, ou lorsque le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 409EMAIL_TEMPLATE_IN_USE : un courriel programmé utilise ce modèle.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

curl -X DELETE https://api.honkio.ca/v1/templates/ID_OR_ALIAS \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Publier le brouillon en tant que nouvelle version

Paramètres

Réponses

• 200Le modèle, avec la nouvelle version publiée. Quand rien n’a changé depuis la dernière publication, le modèle tel quel, sans nouvelle version.›

  Champ	Type	Description
  idobligatoire	string
  objectobligatoire	string	Une valeur parmi : template
  nameobligatoire	string
  aliasobligatoire	string	Peut être null
  default_languageobligatoire	string	La langue qu’un envoi utilise quand il n’en nomme aucune, et celle dont les parties remplacent une partie qui manque à l’autre langue. Une valeur parmi : en | fr
  variables[]obligatoire	object[]
  keyobligatoire	string
  fallback	string	Utilisée quand un envoi ne fournit aucune valeur. Absente quand la variable n’en a pas.
  from_addressobligatoire	string	L’expéditeur de courriel par défaut. Peut être null
  reply_toobligatoire	string[]
  partsobligatoire	object	Les parties du brouillon par langue : la langue par défaut toujours, l’autre quand elle a une partie.
  en	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  fr	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  published_versionobligatoire	integer	La version qu’utilisent les envois de production. Null jusqu’à la première publication. Peut être null
  has_unpublished_changesobligatoire	boolean	True quand le brouillon diffère de la version publiée dans une partie ou une langue.
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED : les modèles n’ont pas de mode test, et cette opération change ce que les envois de production reçoivent. Une clé de test peut créer un modèle, modifier son brouillon et envoyer des courriels de test qui utilisent le brouillon. Aussi FORBIDDEN lorsque la clé ne dispose pas de la permission requise par cette opération, ou lorsque le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

curl -X POST https://api.honkio.ca/v1/templates/ID_OR_ALIAS/publish \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Republier une version antérieure en tant que nouvelle version

Paramètres

Corps de la requête

Réponses

• 200Le modèle, avec la version antérieure publiée de nouveau comme nouvelle version.›

  Champ	Type	Description
  idobligatoire	string
  objectobligatoire	string	Une valeur parmi : template
  nameobligatoire	string
  aliasobligatoire	string	Peut être null
  default_languageobligatoire	string	La langue qu’un envoi utilise quand il n’en nomme aucune, et celle dont les parties remplacent une partie qui manque à l’autre langue. Une valeur parmi : en | fr
  variables[]obligatoire	object[]
  keyobligatoire	string
  fallback	string	Utilisée quand un envoi ne fournit aucune valeur. Absente quand la variable n’en a pas.
  from_addressobligatoire	string	L’expéditeur de courriel par défaut. Peut être null
  reply_toobligatoire	string[]
  partsobligatoire	object	Les parties du brouillon par langue : la langue par défaut toujours, l’autre quand elle a une partie.
  en	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  fr	object	Les parties d’une langue. Un envoi dans cette langue utilise sa partie pour le canal quand elle en a une, sinon celle de la langue par défaut.
  emailobligatoire	object | any	La partie courriel, ou null quand cette langue n’en a pas.
  smsobligatoire	object | any	La partie SMS, ou null quand cette langue n’en a pas.
  push	object | any	La partie notification push, ou null quand cette langue n’en a pas.
  published_versionobligatoire	integer	La version qu’utilisent les envois de production. Null jusqu’à la première publication. Peut être null
  has_unpublished_changesobligatoire	boolean	True quand le brouillon diffère de la version publiée dans une partie ou une langue.
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED : les modèles n’ont pas de mode test, et cette opération change ce que les envois de production reçoivent. Une clé de test peut créer un modèle, modifier son brouillon et envoyer des courriels de test qui utilisent le brouillon. Aussi FORBIDDEN lorsque la clé ne dispose pas de la permission requise par cette opération, ou lorsque le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND : aucun modèle correspondant, ou aucune version correspondante de ce modèle.Le corps d’erreur standard.
• 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

curl -X POST https://api.honkio.ca/v1/templates/ID_OR_ALIAS/rollback \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "version": 2
  }'

Lister les versions publiées d’un modèle, de la plus récente à la plus ancienne

Paramètres

Réponses

• 200Les versions publiées, de la plus récente à la plus ancienne.›

  Champ	Type	Description
  data[]obligatoire	object[]
  versionobligatoire	integer
  published_atobligatoire	string	Format : date-time
  currentobligatoire	boolean	True pour la version qu’utilisent les envois de production.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

curl https://api.honkio.ca/v1/templates/ID_OR_ALIAS/versions \
  -H "Authorization: Bearer mk_live_YOUR_KEY"