PUT v1/entities({CompanyId})/lockReasons({LockReasonId})
Update a Lock Reason for a Company
Information:
Base URL:
https://api.covasoft.net/usermanager
Example of a call would be:
https://api.covasoft.net/usermanager/v1/entities({CompanyId})/lockReasons({LockReasonId})
Example of the Body of the Call:
{ "Id": 36, "Name": "FMLA", "Description": "Your account has been locked due to being on FMLA. Please contact your supervisor with any questions." }
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
LockReasonId |
The Lock Reason for which you want to Update |
integer |
Required |
Body Parameters
The Lock Reason Name and Description - see example above
UpdateALockReasonPostName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": 1, "Name": "sample string 2", "Description": "sample string 3" }
Response Information
Resource Description
Updated Lock Reason with Id
UpdateALockReasonReturnName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "Name": "sample string 2", "Description": "sample string 3" }