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

Permission to run the request: Account Owner, Administrator. 


Request Headers

X-Auth-Account-Url (required)Base URL of the account, e.g.
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 that will be displayed in User Portal.
X-Instruction-Message (optional)Instruction Message that will be displayed in User Portal.
X-Show-History-Reports (optional, default: 1)0 or 1
X-Courses-Sort-Column (optional)

Specify how to sort courses in User Portal: by status, title or duration.


  • status
  • title
  • duration

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

Possible Response Codes

403Permission deniedYou have no permission to change the setting of User Portal. Only Account Owner and Administrator have permission to send the request.
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
X-Auth-Password: password
X-User-Portal-Enabled: 1
X-Welcome-Title: Welcome title
X-Instruction-Message: Instruction Message
X-Show-History-Reports: 0
X-Courses-Sort-Column: status


Sample Response

HTTP/1.1 200 OK
Connection: close