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)
If updateRoles is true 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

Update a Person

Example HTTP Request Body - All fields are optional

Response

Field Descriptions