Newsletter API

Newsletter Subscriber API Documentation

Actions

Endpoint: api/v1/app_promotion/newsletter/subscriber/
Method: POST
Permissions: AllowAny

---

Description

This API endpoint allows users to subscribe to a newsletter. Upon successful subscription, a thank-you email is sent to the subscriber.

---

Request

Headers:

• Content-Type: application/json
• Authorization: Not required (publicly accessible).

Body Parameters:

Field	Type	Required	Description
email	string	Yes	Email address of the user.

Example Request:

{
    "email": "user@example.com"
}

---

Response

On Success:

Status Code: 201 CREATED

Body:

{
    "success": "Subscription successful"
}

On Failure:

Status Code: 400 BAD REQUEST

Body (Example):

{
    "email": ["Enter a valid email address."]
}

---

Error Responses

Status Code	Reason	Example Body
400	Validation Error	{"email": ["Enter a valid email address."]}
500	Server Error	{"error": "An unexpected error occurred."}

---