WOworkramp

Update User

Updates a user's attributes

post/api/v1/users/{user_id}

Request

  • Base URL
    https://app.workramp.com
  • URL
    https://app.workramp.com/api/v1/users/{user_id}
  • Auth
    API key in header Authorization

Path parameters

user_idinteger required

ID of user to update

Request body

emailstring

[Optional]

namestring

[Optional]

isAdminboolean

[Optional]

isDeletedboolean

[Optional]

managerEmailsstring[]

[Optional] Array of existing manager emails.

overwriteManagerEmailsboolean

[Optional] If set to true, user's managers will be exactly what managerEmails is set to. Having an empty array for mangerEmails while this is true will delete all managers of the user.

Response

200

idinteger
namestring
emailstring
isAdminboolean
isDeletedboolean
isPermanentlyDeletedboolean
createdAtnumber
updatedAtnumber

Example response

{
  "id": 5065,
  "name": "Jane Doe",
  "email": "ted+apitester1234@workramp.com",
  "createdAt": 1488144236206.5808,
  "updatedAt": 1488144236206.5808,
  "mentors": [
    {
      "id": 7,
      "name": "John Doe",
      "email": "jdoe@workramp.com",
      "createdAt": 1564692110394,
      "updatedAt": 1589355546681
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.