User avatar

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
file required	Avatar file form data format Validations: Must be a ActionDispatch::Http::UploadedFile

Examples

// Missing file param
POST /api/v2/user/avatar
422
{
  "error": "Missing parameter file"
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Examples

// Successfull request
DELETE /api/v2/user/avatar
200
{
  "ok": "avatar deleted successfully"
}

// When avatar not attached
DELETE /api/v2/user/avatar
400
{
  "error": "Avatar not attached"
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters