The update command is used to modify the configuration of a gate.

JSON Input Data Format
{
    "id": string,
    "name": string,
    "smtpserver": string,
    "smtpport": integer,
    "smtpuser": string,
    "smtppass": string,
    "smtptemplate": string,
    "posturl": string,
    "postheader": string,
    "postdata": string
}
id * Specifies the ID of the gate.
name * Specifies the name of the gate, which can be any desired name.
smtpserver * Specifies the SMTP server host or domain name.
smtpport * Specifies the SMTP server port number.
smtpuser * Specifies the SMTP server username.
smtppass * Specifies the SMTP server user's password.
smtptemplate * Specifies additional email configurations in JSON format, which should follow this structure:
The following rules need to be considered:
  • #GATE-NAME#
    The tag #GATE-NAME# will be replaced with the name of the Notification Gate.
  • #PAYLOAD#
    The tag #PAYLOAD# will be replaced with the JSON input data that was received.
  • Delimiter: ^^
    The delimiter ^^ will be replaced with a new line feed character.
posturl * Specifies the POST URL for the request.
postheader * Specifies the headers to be included in the POST request. Please provide the headers in JSON format, as shown in the example below:
postdata * The follwing rules need to be considered:
  • #GATE-NAME#
    The tag #GATE-NAME# will be replaced with the name of the Notification Gate.
  • #PAYLOAD#
    The tag #PAYLOAD# will be replaced with the JSON input data that was received.
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": "The process was successfully completed"
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}