Call

In this call, you can update specific fields about a user using the user schema. Making it possible to update just one field of the complete schema of fields.

You will use a user’s userResourceGuid (user unique identifier) to get all the API-exposed information the system has on them.

A user’s userResourceGuid can be obtained in multiple ways:

• Data reports
• Using APIs
  • Search users
  • Create a new user
• Through UI
  • User’s profile URL: If you go to a user’s profile page (either alumni admin or alumni portal), you will be able to see the userResourceGuid in the browser’s URL. It will be a long alphanumeric value separated by hyphens.
    • In Alumni Portal: https://alumni.example.com/alumni/portal2/profile/id/a18895c4-862f-4a91-a9c1-44a9ecf51a28
    • In Alumni Admin: https://alumni.example.com/alumni/admin/#/crm/a18895c4-862f-4a91-a9c1-44a9ecf51a28

Prerequisites

• The field to be updated must be set as API exposed on Field Manager and should have the value as specified on the “Return user schema” API.
• Required fields cannot be sent with empty values.
• The user ResourceGuid (Alumni unique identifier) must be populated to execute this API.

Example

The following example shows a schema that will update the user’s last name:

{
  "lastName": "Doe"
}

Response

This API will return an empty message if the validation was successful or a message with the error if there was something wrong in the schema.

API URL: https://gateway.enterprisealumni.com/api/v2/user/userResourceGuid

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.