Senders

Update Sender

Update the display name and/or the reply-to address of an existing sender.

PATCHhttps://graph.sendcorex.com/v3.0/senders/:id

Body parameters

idstringrequired
The sender ID, in the URL path.
e.g. "N4U292XC2ZD9W79UF4X4PSY0"
fromstringoptional
New display name for the sender.
e.g. "Johnny Smith"
replyTostringoptional
New reply-to email address.
e.g. "johnny@sendcorex.com"

Quick start

import axios from 'axios';

const response = await axios.patch(
  'https://graph.sendcorex.com/v3.0/senders/N4U292XC2ZD9W79UF4X4PSY0',
  {
    from: "Johnny Smith",
    replyTo: "johnny@sendcorex.com"
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

console.log(response.data);

Response

{
  "success": true,
  "code": "SENDER_UPDATED",
  "sender": {
    "id": "N4U292XC2ZD9W79UF4X4PSY0",
    "from": "Johnny Smith",
    "replyTo": "johnny@sendcorex.com"
  }
}

Response fields

code
SENDER_UPDATED when the sender was updated.
sender.id
The sender ID.
sender.from / replyTo
The values after the update.

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.