Skip to content
  • There are no suggestions because the search field is empty.

Bulk Edit Users in Phin Api Route

This route is used to bulk edit users under a company in Phin.

User Attribute Reference

Field Name Description Value Type
id Unique Id of the user String
first First name String
last Last name String
email Email String
deptid Department ID String
deptname Department Name String
supvemail Supervisor Email String
supvname Supervisor Name String
emplid Employee ID String
title Employee Title String
ophone Office Phone Number String
phone Phone number String

 

Response Reference

Field Type Example
Body JSON { success: true, editedUserIds: ['111111','222222','333333'] }

Response Sample

{ success: true, editedUserIds: ['111111','222222','333333'] }
Error Reference
Code Message Explanation
200 { success: true, editedUserIds } The users were successfully edited with the fields sent.  
207 { message: 'Partial success. Some users failed to be updated.', editedUserIds, failures } Partial success. Some users were edited successfully while others failed.  
400 { error: 'Users failed to be updated.', failures } All users were not edited. The request contained bad information such that all users failed.  
500
{ error: 'Failed to edit users. Please try again or contact Phin Support for assistance.' }
 Something went wrong editing the users. Try again later or contact Phin.  

Additional Notes:

It is not possible to modify externally synced users (Azure/Google sync) because they are controlled by their respective systems.