/
Update a Person
Update a Person
URI: https://api.cloudcard.us/person/{id}
Example URI: https://api.cloudcard.us/person/123
Example URI: https://api.cloudcard.us/person/jon.doe@foo.edu?findBy=email
Example URI: https://api.cloudcard.us/person/A1234567?findBy=identifier
Optional URL Parameters:
findBy=[id|email|identifier]
(default id)updateRoles=[true|false]
(default true)
IfupdateRoles
istrue
or absent, any roles not explicitly granted will be removed
HTTP Method: PUT
Required Headers: X-Auth-Token (see: Authentication)
Optional URL Parameters: none
Example HTTP Request Body - All fields are optional
{
"email": "jon.doe@foo.edu",
"identifier":"ABC123",
"Some Custom Field Name":"Some Custom Field Value",
"Another Custom Field Name":"Another Custom Field Value",
"ROLE_DIRECTOR":false,
"ROLE_OFFICE":true,
"cardholderGroupName":"Online Students",
"additionalPhotoRequired":true ,
"enabled":true
}
Response
202 ACCEPTED
Field Descriptions
, multiple selections available,
Related content
Create a Person
Create a Person
More like this
List People
List People
More like this
Organization
Organization
More like this
Authentication
Authentication
Read with this
Organization Switching (for Administrators or Super Directors Only)
Organization Switching (for Administrators or Super Directors Only)
More like this
Person Field Descriptions
Person Field Descriptions
Read with this