Signups
Double opt-in signups from your own site, with a key that is safe in public code.
- POST /signups — Sign up a subscriber
post/signups— Sign up a subscriber
For your site's signup form. Use a signups key: it can do nothing else, so it is safe in public code. The contact stays pending until they click the confirmation email (double opt-in). The answer is the same for every address. Limited to 5 signups per IP per 10 minutes.
Keys: signupsfull_access · accepts Idempotency-Key · CORS open
Body
| emailrequired | string | |
| name | string | |
| segment_id | uuid | Optional when the workspace has a single active newsletter. |
| language | string | |
| source_url | string | Page the form was on (attribution). |
curl -X POST https://api.smartletter.ai/signups \
-H "Authorization: Bearer $SMARTLETTER_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"jane@example.com","name":"Jane","source_url":"https://acme.com/blog"}'Response 202
{
"object": "signup",
"status": "pending"
}