Receive Emails: Templates

Use Template

Get the subject and body ready to send, with the placeholders filled, and count the use.

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

send_email, reply and schedule_send also take template_id directly. Use this command when you want to edit the text before sending.

Arguments

  • idstringrequired

    The template_id.

  • to_namestringoptional

    Fills {first_name}, {last_name} and {name}.

  • to_emailstringoptional

    Fills {email}.

  • variablesobjectoptional

    Your own placeholders: { "company": "Acme" } fills {company}.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "use_template",
        args: {
          id: "Vj0xVFBMMDAx",
          to_name: "Ana Costa",
          variables: {
            company: "Acme"
          }
        }
      }
    ]
  },
  { 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);

Response

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "use_template",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "id": "Vj0xVFBMMDAx",
        "subject": "Our pricing",
        "html": "<p>Hi Ana,</p><p>Here is our pricing…</p>"
      }
    }
  ]
}

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

  • 401TOKEN_EXPIRED

    The access token has expired. Call Refresh Token and repeat the request.

  • 401INVALID_TOKEN

    The token is malformed, unknown or revoked.

  • 429RATE_LIMITED

    More than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.

  • CMDINVALID_ARGS

    A required argument is missing or invalid.

  • CMDNOT_FOUND

    The message, thread or folder does not exist for this token.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.