Update FTP welcome message

This function sets the FTP welcome message.

Important:

When you disable the FTP role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

message

required

string

The cPanel account's new FTP welcome message.

Example: message=Greetings, Professor Falken.

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Ftp/set_welcome_message

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Ftp \
  set_welcome_message \
  message='Greetings, Professor Falken.'

Response samples

application/json

{"apiversion": 3,
"func": "set_welcome_message",
"module": "Ftp",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}