Subscribe to email lists (authenticated)
Subscribe a contact to one or more email lists. This is an authenticated endpoint that requires a bearer token.
Unlike the public /subscribe endpoint, this endpoint can subscribe contacts to any list (public or private) as long as the authenticated user has write permission on lists.
Note: Double opt-in is bypassed for authenticated requests. Contacts are immediately set to active status regardless of the list's double opt-in setting. This allows administrators to manually add contacts without requiring email confirmation.
post/api/lists.subscribe
Request body
Example request
{
"workspace_id": "ws_1234567890",
"contact": {
"email": "user@example.com",
"email_hmac": "a1b2c3d4e5f6...",
"external_id": "user_12345",
"timezone": "America/New_York",
"language": "en-US",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"phone": "+15551234567",
"address_line_1": "123 Main St",
"address_line_2": "Apt 4B",
"country": "US",
"postcode": "10001",
"state": "NY",
"job_title": "Software Engineer",
"custom_string_1": "Premium tier",
"custom_number_1": 42,
"custom_datetime_1": "2023-06-01T09:00:00Z",
"custom_json_1": {
"preferences": {
"theme": "dark",
"notifications": true
}
}
},
"list_ids": [
"newsletter",
"product_updates"
]
}Response
Subscription successful
Example response
{
"success": true
}