Clerk.io Developer Documentation
API Reference
API ReferenceHelp ArticlesService StatusProduct UpdatesLog In

subscriber/subscribe

get
https://api.clerk.io/v2/subscriber/subscribe

Subscribe an email address globally or to a specific list

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

You store API key.

string
required

The email address to subscribe for email marketing.

string

An optional ID of a list for the email address to be subscribed to. Email address will also be subscribed globally if it was not already.
List IDs are found in my.clerk.io under Email > Lists.

boolean
Defaults to false

If true, redirects the user to my.clerk.io to confirm subscription. Can be combined with redirect_url to send user to a specific URL.

string

An optional URL to redirect to after the user is successfully subscribed.

Response

Updated 12 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago