Skip to main content

Create virtual sender

Description

Creates a new virtual sender.

Request URL

Method: POST

https://example.com/api/v1.1/vsenders/add

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoResponse data format
By default – json
namestring"New virtual sender"YesNew virtual sender name
email_rulesJSON array
YesRules for email senders
sms_rulesJSON array
YesRules 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

ParameterTypeDescription
errorintError code
error_textstringError text
saved_idintNew virtual sender ID