Rules

API request format

https://email.api.engagelab.cc/v1/<module>/<action>

Module: name of function module, e.g. mail module, addresslist module.

Action: action of each module, e.g. send, add.

API return code

API is returned in the format of JSON.Sample is as below:

          # request was successful
{
 
  "result": {}
}
# Authentication failed
{
  "code": 30000,
  "message": "Authentication failed",
}

# Data acquisition success
{
    
   "total": 28,
   "count": 28,
   "result": [
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-10T15:47:05+0800",
                "update_time": "2022-11-10T15:47:05+0800"
            }
        ]
    
}

        

• httpStatus: 200
• result: Data information

HTTP status code

Email address format description

Email address format: local_part@domain_part , by local_part, @ and domain_part composition.The legal email address must meet the following rules:

• local_part@domain_part minimum length includes 6 characters and the maximum length is 128 characters;
• local_part maximum length of the part string is 96 characters and cannot contain the @ character;
• domain_part can only contain a-zA-Z0-9 -. It cannot start with - or end with -. The total length does not exceed 255 characters, and each segment does not exceed 63. The top-level domain can only contain 2 to 20 uppercase and lowercase English letters;

Time zone dictionary

Calendar time zone dictionary

Rate Dictionary

Filter Conditions

Filter Condition Structure

          {
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "createTime",
                "op": ">=",
                "value": "2021-10-11"
            },
            {
                "field_name": "Name",
                "op": "contain",
                "value": "left"
            }
        ]
    }
}

# Filter condition: createTime >= '2021-10-11' or Name contains 'left'

        

Filter Condition Explanation