Skip to main content
POST
Resubscribe Recipient
When someone clicks the unsubscribe link in an email, Shipstar marks them unsubscribed and no upsert, add or restore ever changes that row again — a bulk sync must never be able to undo an opt-out by accident. Two things can: the person clicking Resubscribe on the unsubscribe confirmation page, and this call, which records an opt-in the signed-in person made in your product (turning a “Product updates” switch back on, re-ticking a newsletter box). It is deliberately different from an upsert: one recipient per call, and a consent block that says where and when the person opted in. That block is stored on the recipient as its consent record and returned on every recipient read, so you can show your auditors who opted in, how and when. What happens, by the recipient’s current status: Matching is by external_id first, then by email. Sending a new email for an existing external_id changes the address in place (and rotates that person’s unsubscribe link). Activating a recipient counts against the list’s plan cap exactly like an upsert.
Call this from the code path where the person flips the switch, not from your nightly sync. Your sync should keep using upsert and treat skipped_unsubscribed as the person’s final word until they opt in again — and should subscribe to the mailing_list.resubscribed webhook so an opt-in made on Shipstar’s confirmation page flips your own flag too. See Hearing about unsubscribes and resubscribes.

Authentication

This endpoint requires an API token passed as a Bearer token in the Authorization header.

Path Parameters

string
required
The mailing list’s unique identifier (UUID).

Body

At least one of email and external_id. Without an email, an unknown external_id is a 404 — there is nothing to add.
string
Your own id for this person, up to 255 characters. Matched first.
string
Email address (case-insensitive). Required to add someone who is not on the list; changes the address of an external_id-keyed recipient.
string
Display name, up to 200 characters. Applied when sent.
object
Up to 20 keys with string, number, boolean or null values; replaces the stored map when sent.
Where and when the person opted in on your side.

Request

Response

string
required
resubscribed, added, reactivated or already_active — see the table above.
object
required
The recipient as List Recipients returns it, now active, including the consent record just written:
200

Errors

Error bodies carry a stable code next to the human-readable detail.

Rate Limits

This endpoint is limited to 30 requests per minute per IP.