Skip to main content

​
URL structure

​
Supported methods and overview

​
Detailed description

This API endpoint sets a new help URL for documentation relating to the Safe Share web application. To reset this URL 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):
  • System administrator
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 the new help URL for documentation relating to the Safe Share web application in the body of the request as plain text.

​
Returns

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