SMTP Gateway

Update gateway info

Updates gateway information

put/v1/gateway/edit/{gateway}

Request

Base URL: https://your-emailengine-host
URL: https://your-emailengine-host/v1/gateway/edit/{gateway}
Auth: HTTP bearer

Path parameters

gatewaystring required

Gateway ID

Example:example

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

namestring

Account Name

userstring nullable

SMTP authentication username

passstring nullable

SMTP authentication password

hoststring

Hostname to connect to

portinteger

Service port number

secureboolean

Should connection use TLS. Usually true for port 465

Example request

{
  "name": "John Smith",
  "user": "smtp-user",
  "pass": "verysecret",
  "host": "smtp.gmail.com",
  "port": 465,
  "secure": true
}

Response

Returns the updated gateway.

gatewaystring required

Gateway ID

Example response

{
  "gateway": "example"
}

Changes

No recorded changes to this operation across all 1 revision of this API.