Subscribers

Add a subscriber

post/lists/{listId}/subscribers

Request

  • Base URL: https://api.tinysend.com/v1
  • URL: https://api.tinysend.com/v1/lists/{listId}/subscribers
  • Auth: HTTP bearer

Path parameters

listIdstring required

Request body

emailstring email required
namestring
verifiedboolean

Whether consent has already been verified. Default false: the subscriber is created 'pending' and a double opt-in confirmation email is sent — they become active only after clicking it. Set true ONLY when you have verified consent upstream (e.g. your own confirmed signup); the subscriber is then created 'active' with no confirmation email, attributed as verified via API.

tagsstring[]

Person-level labels merged onto the contact (unioned with existing). Render in Apple Contacts as CATEGORIES.

metadataobject

Arbitrary per-person key/values, shallow-merged onto the contact. For segmentation/display.

orgstring

Company — written to the contact.

job_titlestring

Role/title — written to the contact.

Example request

{
  "tags": [
    "pro",
    "from:better-auth"
  ],
  "metadata": {
    "plan": "pro",
    "signup_source": "web"
  }
}

Response

Created subscriber

idstring required
emailstring nullable required
namestring nullable required
statusstring required
sourcestring nullable required
subscribed_atstring nullable required
created_atstring required
waitlist_statusstring nullable
positioninteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.