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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "name": "New virtual sender",
    "email_rules": [
        {
            "senders": [
                {
                    "from_email": "",
                    "from_name": "",
                    "percent": 100,
                    "replyto_email": "",
                    "sender_id": 3
                }
            ],
            "type": "default",
            "value": ""
        }
    ],
    "sms_rules": []
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <name>New virtual sender</name>
    <email_rules array ='true'>
        <senders array = 'true'>
            <from_email/>
            <from_name/>
            <percent>100</percent>
            <replyto_email/>
            <sender_id>3</sender_id>
        </senders>
        <type>default</type>
        <value/>
    </email_rules>
</xml>

Response example

JSON

{
    "data": {
        "saved_id": 8
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <data>
        <saved_id>9</saved_id>
    </data>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
saved_id	int	New virtual sender ID