logo
EasyListing
Api reference/Subscriber

Create

➕ Create a Subscriber

The Create Subscriber endpoint allows you to add new subscribers to a waitlist.

📌 Endpoint

POST /create/subscriber

🔑 Authentication

Include your API key in the request header:

EL_API_KEY: YOUR_SECRET_API_KEY

🔤 Request Body

FieldTypeRequiredDescription
emailString✅ YesThe subscriber's email address
subscribedToString✅ YesThe ID of the waitlist the subscriber is joining
metaDataObject❌ NoOptional metadata (e.g., {"source": "landing_page"})
firstNameString❌ NoSubscriber's first name
lastNameString❌ NoSubscriber's last name

⚠️ If firstName and lastName are not provided, they will default to "Not provided".

🔄 Status Logic

  • If Require Approval is enabled → Status = Pending
  • If Require Approval is disabled and Use DOI is also disabled → Status = Approved
  • If Use DOI is enabled and Require Approval is disabled → Status = Pending until the user verifies their email, then it changes to Approved.

✅ Successful Response

{
	"error": null | "string",
	"message": "string",
	"ok": boolean,
	"doiToken": null | string,
	"doiEmailSend": boolean,
	"unSubToken": "string",
	"newSub": {
		"firstName": "string",
		"lastName": "string",
		"email": "string",
		"referCode": "string"
	}
}

🔗 For more details on DOI tokens, visit /api-reference/doi.


❌ Possible Errors

Error CodeMessageStatus
MAXIMUM_SUBSCRIBERS_REACHEDThe maximum sign-ups for this waitlist have been reached400
USER_ALREADY_SUBSCRIBEDThis user joined this waitlist already400
MISSING_SUBSCRIBER_IDNo Subscriber Id provided400
SUBSCRIBER_NOT_EXISTINGThis subscriber does not exist404
WAITLIST_NOT_LIVEThis waitlist is currently not live. Please try again later400

For further API details, check out the API Reference.

On this page