Update a subscription

PUT

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

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

• Production

Changes the subscription status for a contact on a single newsletter, identified by {email} and {channelSlug} in the URL. See the subscription status table on Add or update subscriptions in bulk.

This is a company-level (v3) write. Authenticate with a company API key as a Bearer token.

Authorizations

• bearerAuth

Parameters

Path Parameters

email

required

string

The contact’s email address, URL-encoded.

channelSlug

required

string

The newsletter’s channel identifier (slug).

Request Body ^required

Media type application/json

object

api

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

boolean

status

integer

Example

{
  "api": true,
  "status": 1
}

Responses

200

200 OK. Returns the updated contact — same shape as GET /api/v3/contacts/{email}.

Media type application/json

object

items

The contact, with the subscription’s status updated. Full field list under GET /api/v3/contacts/{email}.

object

message

string

total

integer

Example

{
  "items": {
    "email": "[email protected]",
    "subscriptions": [
      {
        "channel": {
          "slug": "weekly-digest",
          "name": "Weekly Digest"
        },
        "status": 1,
        "createdAt": "2026-04-30T15:22:41+00:00",
        "updatedAt": "2026-08-30T15:01:21+00:00"
      }
    ]
  },
  "message": "Subscription updated.",
  "total": 1
}