Set or clear a channel's default sender

POST

/api/v3/channels/{channel}/default-sender

curl --request POST \
  --url https://api.tryletterhead.com/api/v3/channels/example/default-sender \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form api=true \
  --form senderUniqueId=example

• Production

Set this channel’s default sender (the identity the composer preselects for new newsletters on this channel), or clear it by omitting senderUniqueId or sending it empty. At most one sender per channel can be the default.

v3 endpoints expect a company API key.

Authorizations

• bearerAuth

Parameters

Path Parameters

channel

required

string

The newsletter’s channel identifier (slug).

Request Body ^required

Media type multipart/form-data

object

api

required

When set to true, this endpoint will accept authorization with your API Key.

string

Example

true

senderUniqueId

Optional. The uniqueId of a sender already assigned to this channel (see GET /api/v3/channels/{channel}/senders). Omit or send empty to clear the channel’s default sender instead.

string

Responses

204

The default sender was set (or cleared, when senderUniqueId was empty). No response body.

401

401 Unauthorized — missing or invalid company API key.

404

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

Media type application/json

object

data

Array<object>

object

items

Array<object>

object

message

string

total

integer

Example

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

422

422 Unprocessable Entity — senderUniqueId doesn’t match a sender assigned to this channel.

Media type application/json

object

data

Array<object>

object

items

Array<object>

object

message

string

total

integer

Example

{
  "data": [],
  "items": [],
  "message": "This sender is not available on this channel.",
  "total": 0
}