Email Subscription Interface

Users submit their email addresses for email subscription, used to receive the latest information, updates, or other email content from the website.

Precautions

This interface uses the POST method and requires data to be submitted in application/ format
A valid email address is required.
Support adding notes and categories for subscribers
After subscription, the user will receive an email confirmation or be directly added to the subscription list
The email address needs to be validated for format

Request address

{域名地址}/api/subscription

Description:{域名地址}Need to replace it with your domain address, such ashttps://en.anqicms.com/api/subscription

Request syntax

POST {域名地址}/api/subscription
Content-Type: application/json

Request header

This interface also involves common request headers. For more information, please seeCommon Request Headers (Common Request Headers).

Request Parameters

Field Name	Type	Required	Description
email	string	Yes	Email address, used to receive subscription emails
remark	string	No	Optional user remarks information
status	integer	No	Subscription status, used to identify the subscriber's status
category_id	integer	No	Subscriber category ID, used to classify subscribers

Response Headers

This interface only involves public response headers. More information, please refer toCommon Request Headers (Common Request Headers).

Return parameters

Field Name	Type	Description
code	integer	Error code
message	string	Error Description

Example Usage

Request Example

POST /api/subscription HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

{
  "email": "[email protected]",
  "remark": "来自网站首页订阅",
  "category_id": 1
}

Response Example

{
  "code": 0,
  "msg": "订阅成功"
}

Error Code

Error code	Description
0	OK
-1	Error, the reason is indicated in msg
1001	Not logged in
1002	Unauthorized
200	API request OK