Add a subscriber.

POSThttps://app.softsolz.uk/api/v1/services/newsletter/subscribers

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

emailstring

Subscriber email.

namestring

Optional subscriber name.

Response

Response Body

idintegerSubscriber id.

emailstringSubscriber email.

namestring | nullOptional subscriber name.

statusstringSubscription status. "pending" means double opt-in is on and the address has not been confirmed yet.

source_kindstringHow the subscriber arrived (widget, api, manual, import).

source_urlstring | nullPage the address was entered on, kept as consent evidence.

consent_textstring | nullExact wording the person agreed to at sign-up.

consent_atstring | nullWhen consent was given. Null for rows captured before consent was recorded.

confirmed_atstring | nullWhen the address was confirmed; null while pending.

created_atstringWhen the subscriber was added.

unsubscribed_atstring | nullWhen the subscriber unsubscribed; null while subscribed.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.newsletter.createSubscriber({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 201

{
  "data": {
    "id": 0,
    "email": "string",
    "name": "string",
    "status": "string",
    "source_kind": "string",
    "source_url": "string",
    "consent_text": "string",
    "consent_at": "string",
    "confirmed_at": "string",
    "created_at": "string",
    "unsubscribed_at": "string"
  }
}