List a channel's available senders

GET

/api/v3/channels/{channel}/senders

const url = 'https://api.tryletterhead.com/api/v3/channels/example/senders?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/channels/example/senders?api=true' \
  --header 'Authorization: Bearer <token>'

List the sender identities available on this channel — the set that the composer’s “Send from” picker loads. Each sender carries every channel it’s assigned to (not just this one), so you can read its isDefault flag for any of its other channels too.

status (verified/unverified roster status) is left blank on this endpoint — it’s only computed on the company-wide sender list (GET /api/v3/senders).

v3 endpoints expect a company API key.

Authorizations

bearerAuth

Parameters

Path Parameters

channel

required

string

The newsletter’s channel identifier (slug).

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

200 OK

application/json

object

items

Array<object>

object

uniqueId

string

email

string

name

string

replyTo

string

isActive

boolean

status

Always empty on this endpoint.

string

channels

Array<object>

object

channel

string

isDefault

boolean

message

string

total

integer

Example

{
  "items": [
    {
      "uniqueId": "aB3xY9",
      "email": "[email protected]",
      "name": "Example Newsroom",
      "replyTo": "",
      "isActive": true,
      "status": "",
      "channels": [
        {
          "channel": "an-example-channel",
          "isDefault": true
        }
      ]
    }
  ],
  "message": "Channel senders retrieved.",
  "total": 1
}

401

401 Unauthorized — missing or invalid company API key.

404

404 Not Found — no channel matches channel for this company.

application/json

object

data

Array<object>

object

items

Array<object>

object

message

string

total

integer

Example

{
  "data": [],
  "items": [],
  "message": "Channel not found",
  "total": 0
}

Still can’t find what you need? Contact support.