Create a subscription

POST

/api/v3/contacts/{email}/subscriptions

const url = 'https://api.tryletterhead.com/api/v3/contacts/example/subscriptions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"api":true,"channel":"annas-channel","status":2}'
};

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

curl --request POST \
  --url https://api.tryletterhead.com/api/v3/contacts/example/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "api": true, "channel": "annas-channel", "status": 2 }'

Subscribes the contact to a channel. Requires status and either channel (a channel slug) or channelId (the channel’s numeric id, a legacy alternative — channel takes precedence when both are supplied).

Authorizations

bearerAuth

Parameters

Path Parameters

email

required

string

The contact’s email address, URL-encoded.

Request Body^required

application/json

object

api

Required. Set to true to authenticate with an API key.

boolean

channel

A channel slug. Required unless channelId is supplied.

string

channelId

A channel’s numeric id (legacy alternative to channel).

integer

status

required

integer

Example

{
  "api": true,
  "channel": "annas-channel",
  "status": 2
}

Responses

201

Subscription created

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