https://github.com/vmlweb/rest-api-markdown

Last synced: 10 months ago
JSON representation

Template for REST API markdown

README

## Update User Profile
Update the profile for a specific user account.

`PUT /account/{userId}/profile`

### Headers
- **AuthSessionId** - Identifier for current session
- **AuthSessionSecret** - Secret for current session

### Parameters
- **userId** - Identifier for current user

### Body
- **username** - Username to update to
- **email** - E-mail address to update to

### Response
- **userId** - Identifier for the user

### Errors
- **ErrorCode1** - Caused by missing identifier
- **ErrorCode2** - Username was not given
- **ErrorCode3** - Server exploded

### Example Request
`GET /account/1692/profile`

```javascript
{
username: "NewUsername",
email: "Email@Email.com"
}
```

### Example Response
`200 OK`

```javascript
{
userId: 1692
}
```