Page tree
Skip to end of metadata
Go to start of metadata

You can change User Portal settings by sending the POST request to the following URL: /account/user_portal.

Request Headers

ParameterDescription
X-Auth-Account-Url (required)Base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)Administrator/Publisher e-mail address.
X-Auth-Password (required)Administrator/Publisher password.
X-User-Portal-Enabled (optional, default: 1)0 or 1
X-Welcome-Title (optional)Welcome Title to be displayed on User Portal.
X-Instruction-Message (optional)Instruction Message to be displayed on User Portal.
X-Show-Public-Content (optional, default: 1)0 or 1
X-Show-History-Reports (optional, default: 1)0 or 1
X-Show-Tags (optional, default: 0)0 or 1

After the request has been completed, the system returns the response with Code 200.

Possible Response Codes

CodeTextDescription
400Bad RequestThe system failed to process the request, because it did not contain all necessary parameters.
200OkUser Portal settings have been changed.

 

Sample Request

POST /account/user_portal HTTP/1.1
Host: api.ispringonline.com
X
-Auth-Account-Url: http://myaccount.ispringonline.com
X
-Auth-Email: email@email.com
X
-Auth-Password: password
X
-User-Portal-Enabled: 1
X
-Welcome-Title: Welcome title
X
-Instruction-Message: Instruction Message
X
-Show-Public-Content: 1
X
-Show-History-Reports: 0
X
-Show-Tags: 0

Sample Response

HTTP/1.1 200 OK
Server: nginx
Connection: close
  •