Waitlist

Join a waitlist

post/lists/{listId}/join

Request

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

Path parameters

listIdstring required

Request body

emailstring email

Person joining by email (double opt-in). Omit to join as the authenticated agent identity.

namestring
refstring

Referrer's referral code, to credit a referral.

Response

Join result

status'created' | 'exists' | 'full' | 'invalid' required
subscriber_idstring nullable required
positioninteger nullable required
referral_urlstring nullable required

Changes

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