SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
blogs

Add a subscriber.

Add a subscriber.

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

Recent Requests

Log in to see full request history
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

idstringSubscriber id (numeric string).
emailstringSubscriber email.
statusstringSubscription status. "pending" when double opt-in is on for this workspace.
created_atstringWhen the subscriber was added.
insertedbooleanTrue when this call created a new row.
createdbooleanSame value as inserted.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.blogs.createSubscriber({});
console.log(result);

Credentials

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

Response · 201

{
"data": {
"id": "string",
"email": "string",
"status": "string",
"created_at": "string",
"inserted": true,
"created": true
}
}