API Documentation
<access-service>/api/v1/config/theme/headerTextColor

URL structure

https://access-service.xy-company.com/api/v1/config/theme/headerTextColor

Supported methods and overview

  • PUT - used to set a new color for the header text of the Safe Share web application, Covata Administration and Covata Notification email messages.
  • DELETE - see <access-service>/api/v1/config/theme/... for more information.

Detailed description

This API endpoint sets a new color for the header text of the Safe Share web application, Covata Administration and Covata Notification email messages.

To reset this color back to its default value, see <access-service>/api/v1/config/theme/... for more information.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

  • Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Required body

Specify as plain text in the body of the request, the new color (as a 6-digit hex value) for the header text of the Safe Share web application, Covata Administration and Covata Notification email messages.

Returns

If the request succeeded, then an HTTP response status 200 OK is returned.