SendcorexDocs

Senders

Create Sender

Create a new sender identity. The email address is generated as emailUsername@domain.

POSThttps://graph.sendcorex.com/v3.0/senders
i

The domain must be verified in your account. A shared domain also works: see Shared Domains for the list.

i

A sender is also a mailbox. To read the emails it receives, generate a token for it in the webmail and use the Receive Emails API.

Body parameters

  • emailUsernamestringrequired

    The username part of the email address, before the @.

    e.g. "john.smith"

  • fromPrefixstringrequired

    The display name shown to recipients.

    e.g. "John Smith"

  • replyTostringrequired

    Full email address where replies should be sent.

    e.g. "john.smith@sendcorex.com"

  • domainstringrequired

    Domain name. It must be verified in your account, or be a shared domain.

    e.g. "sendcorex.com"

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://graph.sendcorex.com/v3.0/senders',
  {
    emailUsername: "john.smith",
    fromPrefix: "John Smith",
    replyTo: "john.smith@sendcorex.com",
    domain: "sendcorex.com"
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

console.log(response.data);

Response

{
  "success": true,
  "code": "SENDER_CREATED",
  "sender": {
    "id": "N4U292XC2ZD9W79UF4X4PSY0",
    "from": "John Smith",
    "username": "john.smith",
    "replyTo": "john.smith@sendcorex.com"
  }
}

Response fields

  • code

    SENDER_CREATED when the sender was created.

  • sender.id

    The new sender ID.

  • sender.from

    The display name.

  • sender.username

    The username part of the email address.

  • sender.replyTo

    The reply-to address.

Errors

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

  • 401INVALID_API_KEY

    The API key is invalid or revoked.