listmonk unofficial
POST/subscribers

Create a subscriber

Creates a subscriber from the supplied subscriber details. The request body may be omitted, and no fields are required by the schema; include values such as email, name, or lists to set subscriber data.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields

Subscriber details to create; the request body may be omitted and no fields are required by the schema.

emailstringoptional
The subscriber's email address.
namestringoptional
The subscriber's name.
statusstringoptional
The subscriber's status.
listsarray<integer>optional
List identifiers to associate with the subscriber.
list_uuidsarray<string>optional
UUIDs of lists to associate with the subscriber.
preconfirm_subscriptionsbooleanoptional
Whether to preconfirm the subscriber's subscriptions.
attribsobjectoptional
Custom attributes to store for the subscriber.

1 status code
200Returns the created subscriber object, including its identifier, timestamps, UUID, email, name, attributes, status, and lists.
dataobjectoptional

Error handling

The request body is optional, and the schema does not require any fields. When provided, email, name, and status must be strings, lists must contain integers, list_uuids must contain strings, preconfirm_subscriptions must be a boolean, and attribs must be an object.