Update Welcome Text
The Update Welcome Text operation updates the welcome message properties of the console.
HTTP method and URI
POST /api/console/operations/update-welcome-text
Request body contents
The request body is expected to contain a JSON object with the following fields:
Name | Type | Rqd/Opt | Description |
---|---|---|---|
welcome-text | String (1-8192) | Optional | The value that should be assigned to the console's welcome text. If a null value is provided the welcome text is cleared. |
classification-text | String (1-1024) | Optional | The value that should be assigned to the console's classification text. If a null value is provided the classification text is cleared. |
reflow-welcome-text | Boolean | Optional | Indicates whether to format the welcome text to fit the width of the user's browser window. If the welcome text is not set this value is ignored. |
Description
This operation allows the API user to update or remove the values assigned to the classification and welcome text values within the console. If the user does not have action/task permission to the Create Welcome Text task status code 403 (Forbidden) is returned.
The request is validated against the schema described in the request body contents section. If the request body is not valid, status code 400 (Bad Request) is returned with a reason code indicating the validation error encountered.
The request body does not need to specify a value for all properties, but rather can and should contain fields only for the properties to be updated. Object properties for omitted fields remain unchanged by this operation. All fields are considered optional but at least one field must be provided on the request; otherwise, status code 400 (Bad Request) is returned.
Authorization requirements
- Action/task permission to the Create Welcome Text task.
HTTP status and reason codes
On success, HTTP status code 204 (No Content) is returned and no response body is provided.
The following HTTP status codes are returned for the indicated operation-specific errors, and the response body is a standard error response body providing the reason code indicated and associated error message.
HTTP error status code | Reason code | Description |
---|---|---|
400 (Bad Request) | Various | Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes. |
403 (Forbidden) | 1 | The API user does not have action/task permission to the Create Welcome Text task. |
Additional standard status and reason codes can be returned, as described in Invoking API operations.