Polaris Users

Patch Polaris User

PATCH /api/.../polarisusers/{id}

Updates polaris user data and returns the result. Currently only updates the 'Enabled' property.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the polaris user.
Allowed properties to change
Name Type
Enabled Boolean
Patch document example:
application/json, text/json 
[
  {
    "value": true,
    "path": "/enabled",
    "op": "replace"
  }
]

Response Information

Example
application/json, text/json 
{
  "PolarisUserID": 105,
  "OrganizationID": 81,
  "ExternalID": "testID",
  "Name": "Quaker Ask Us",
  "BranchID": null,
  "Enabled": true,
  "CreatorID": 1,
  "ModifierID": 1,
  "CreationDate": "2011-02-16T20:28:16.177+04:00",
  "ModificationDate": "2023-03-20T19:00:05.6670938+04:00",
  "NetworkDomainID": null,
  "RecordStatusID": 1,
  "Email": "test@polarislibrary.com",
  "Groups": [
    {
      "GroupID": 1,
      "GroupName": "Administrator"
    },
    {
      "GroupID": 14,
      "GroupName": "No Permissions"
    }
  ]
}

Required Permissions

Permission IDs found here.

StaffMembers_Access(ownerID)
StaffMembers_Modify(ownerID)

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found