Create virtual sender
Description
Creates a new virtual sender.
Request URL
Method: POST
https://example.com/api/v1.1/vsenders/add
Request parameters
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
format | string | "json" | No | Response data format By default – json |
name | string | "New virtual sender" | Yes | New virtual sender name |
email_rules | JSON array | Yes | Rules for email senders | |
sms_rules | JSON array | Yes | Rules for SMS senders |
request example
{
"email_rules": [
{
"senders": [
{
"from_email": "",
"from_name": "",
"percent": 100,
"replyto_email": "",
"sender_id": 1
}
],
"type": "default",
"value": ""
}
],
"name": "New virtual sender",
"sms_rules": [],
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"data": {
"saved_id": 99
},
"error": 0,
"error_text": "Successful operation"
}
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |
saved_id | int | New virtual sender ID |