PUT User

Updates the user with the specified ID.

Request URL

https://{school}.myschoolapp.com/api/user/userId/?t={token}

Request Parameters

userID Property is required The ID of the user to update. This value overwrites whatever is supplied in User.UserID.

Note: The API user must have role access permissions enabled for Edit User Profile Data and Custom Fields. Optionally, impersonate a Platform Manager to grant the proper permissions.

Request Body

A valid XML or JSON User as noted below. Must be an admin to update HostID.


{
  "Email": "MadisonAbelle@blackbaud.com",
  "MaidenName": "Smith",
  "NickName": "",
  "Prefix": "Mrs.",
  "CustomField1": "Custom content"
}
  

Example using curl:


curl -X PUT \
  'https://{school}.myschoolapp.com/api/user/1574489?t={token}&format=json' \
  -H 'content-type: application/json' \
  -d '{"MaidenName": "Smith", "CustomField1": "Custom content"}'
  

Response 200

A ResponseMessage containing the ID of the updated user.

Properties

UserID Read only integer
FirstName   string
LastName   string
Email   string
HostId   string
Greeting   string
MaidenName   string
NickName   string
Prefix   string
Suffix   string
MiddleName   string
OtherLastName   string
Affiliation   string
Gender   string
BirthDate   date

Extended Properties

These fields are returned by /user/extended/(userID)/ in addition to the above field(s).

EthnicityType   integer
Citizenship   string
PersonalWebsite   integer
BoardingOrDay   integer
IsDeceased   boolean
DeceasedDate   date
LivingStatus   string
IsAbroad   boolean
ScreenName   string
IMService   string
IsLost   boolean
CustomField1 - 10   string

Audit Properties

These fields are returned by /user/audit/.

PrimaryKey   integer
FieldName   string
SourceBefore   string
SourceAfter   string
ChangeDate   date
DeceasedDate   date
HandledInd   boolean
DownloadedInd   boolean

Connections

StudentInfo Basic information about enrollment status. StudentInfo

Extended Connections

These connections are returned by /user/extended/(userID)/ in addition to the above connection(s).

AddressList   Array of Address
PhoneList   Array of Phone
OccupationList   Array of Occupation
EducationList   Array of Education
Relationships   Array of Relationship
ProfilePhoto   PhotoItem