SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Newsletter

Update a subscriber status.

Update a subscriber status.

PATCHhttps://app.softsolz.uk/api/v1/services/newsletter/subscribers/{id}

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

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

statusstringrequired

New subscriber status.

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

curl --request PATCH \
  --url https://app.softsolz.uk/api/v1/services/newsletter/subscribers/{id} \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "unsubscribed"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "id": 5001,
    "email": "reader@example.com",
    "name": "Jane Reader",
    "status": "subscribed",
    "source_kind": "api",
    "source_url": "https://example.com/blog/how-we-ship",
    "consent_text": "I agree to receive email updates and understand I can unsubscribe at any time.",
    "consent_at": "2026-06-04T18:11:00.000Z",
    "confirmed_at": "2026-06-04T18:13:00.000Z",
    "created_at": "2026-06-04T18:11:00.000Z",
    "unsubscribed_at": null
  }
}