SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
newsletter

Fetch a single signup card by id.

Fetch a single signup card by id.

GEThttps://staging.softsolz.uk/api/v1/services/newsletter/cards/{id}

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

idintegerCard id.
slugstringURL-safe card slug, unique per tenant.
namestringCard display name.
contentobjectCard copy (heading, description, button_label, footer_text, success_message, collect_name).
appearanceobjectAppearance tokens (colors, theme, font, radius).
statusstringPublish status.
created_atstringCreation timestamp.
updated_atstringLast update timestamp.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.newsletter.getCard('<id>');
console.log(result);

Credentials

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

Response · 200

{
"data": {
"id": 0,
"slug": "string",
"name": "string",
"content": {},
"appearance": {},
"status": "string",
"created_at": "string",
"updated_at": "string"
}
}