Update Sender

Options

Sender Id

Id of the sender

Body (*)

sender's name

Request body which must comply to the following JSON Schema:

{
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string",
      "description" : "From Name to update the sender",
      "example" : "Newsletter"
    },
    "email" : {
      "type" : "string",
      "description" : "From Email to update the sender",
      "format" : "email",
      "example" : "newsletter@mycompany.com"
    },
    "ips" : {
      "type" : "array",
      "description" : "**Only in case of dedicated IP**. IPs to associate to the sender. If passed, will replace all the existing IPs.\n",
      "items" : {
        "required" : [ "domain", "ip" ],
        "type" : "object",
        "properties" : {
          "ip" : {
            "type" : "string",
            "description" : "Dedicated IP available in your account",
            "example" : "123.98.689.7"
          },
          "domain" : {
            "type" : "string",
            "description" : "Domain of the IP",
            "example" : "mycompany.com"
          },
          "weight" : {
            "maximum" : 100.0,
            "minimum" : 1,
            "type" : "integer",
            "description" : "Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs.",
            "format" : "int64",
            "example" : 50
          }
        }
      }
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers