Newsletter Subscription

This guide explains how to interact with the newsletter subscription API endpoint in the Calwe application.

Subscribe to Newsletter

Endpoint

• Method: POST
• URL: /v1/customer/subscribe-to-the-newsletter

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes

Request Body

Parameter	Type	Description	Required	Validation Rules
email	string	Email address	Yes	email, unique:newsletter_subscribers,email

Success Response

{
    "success": true,
    "message": "تم الاشتراك في النشرة البريدية بنجاح",
    "data": [],
    "statusCode": 200
}

Error Responses

Validation Error (422)

{
    "success": false,
    "message": "بيانات غير صحيحة",
    "data": {
        "email": [
            "البريد الإلكتروني مسجل مسبقاً"
        ]
    },
    "statusCode": 422
}

Invalid Email Format (422)

{
    "success": false,
    "message": "بيانات غير صحيحة",
    "data": {
        "email": [
            "البريد الإلكتروني غير صحيح"
        ]
    },
    "statusCode": 422
}

Important Notes

Newsletter Subscription

• Email addresses must be unique
• Subscribers receive regular updates and promotions
• Subscription status is tracked
• Subscribers can opt-out at any time
• Email format is validated
• Duplicate subscriptions are prevented

Data Management

• Subscriber data is stored securely
• Email addresses are verified
• Subscription history is maintained
• Privacy settings are respected
• GDPR compliance is ensured
• Data retention policies are followed

Communication

• Subscribers receive welcome emails
• Regular newsletter updates are sent
• Promotional content is included
• Unsubscribe options are provided
• Email preferences can be managed
• Communication frequency is controlled