Change user role

PUT /admin/users/{user_id}/role

Request Structure

  • role_id: int, required

Example Request

PUT /api/v1/admin/users/5/role HTTP/1.1
Host: tph.io
X-Token: c9c0a840-b5f1-4e0e-84da-e8a4eedfc63b
Content-Type: application/json

{
    "role_id":10
}

Response Structure

  • success: bool
  • messages: string
  • data: object
    • data: object
      • id: int
      • first_name: string
      • last_name: string
      • email: string
      • telephone_number: string
      • mobile_number: string
      • is_active: bool
      • is_enabled: true
      • last_login: string ("2020-12-31 00:00:00")
      • created_at: string ("2020-12-31 00:00:00+00:00")
      • roles: object
        • data: object
          • id: int
          • name: string

Example Response

{
  "success": true,
  "messages":"User role updated.",
  "data":{
    "data":{
      "id":5,
      "first_name":"Customer Staff",
      "last_name":"Example",
      "email":"customerstaff@example.com",
      "telephone_number":null,
     "mobile_number":null,
      "is_active":true,
      "is_enabled":true,
      "last_login":null,
      "created_at":"2018-04-11T10:10:17+00:00",
     "roles":{
        "data":{
          "id":10,
          "name":"Reseller Customer - Company Staff"
        }
      }
    }
  }
}