Update virtual sender

Description

Updates an existent virtual sender configuration.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
account_id	int	306	Yes	Account ID
id	int	12345	Yes	Virtual sender ID
name	string	"New virtual sender"	Yes	Virtual sender name
email_rules	JSON-object		Yes	Rules for email senders
sms_rules	JSON-object		Yes	Rules for SMS senders

Request example

JSON

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

XML

<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
  <name>Virtual sender</name>
  <account_id>3</account_id>
  <id>14</id>
  <sms_rules/>
  <email_rules>
    <senders>
      <from_email></from_email>
      <from_name></from_name>
      <percent>100</percent>
      <replyto_email></replyto_email>
      <sender_id>3</sender_id>
    </senders>
    <type>default</type>
    <value></value>
  </email_rules>
</xml>

Response example

JSON

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

XML

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

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text