Guides
Start typing to search…

Update user approval status (PUT)

This API allows you to change a user’s approval status from their current one to either Approved or Rejected.

Call

In this call, it is possible to change the user’s approval status to either APPROVED or REJECTED, using the “signupStatus” field like you would update any other field. When a user is approved, they are allowed into the Alumni platform and can engage in the community, when they are rejected, they cannot.

Notes

  • The new approval status (APPROVED/REJECTED) must be specified on the call. If using the developer page, the input must look like the following: {"signupStatus":"APPROVED"} or {"signupStatus":"REJECTED"}

Example

The following example shows how to change a user’s status to REJECTED:

{
  "signupStatus":"REJECTED"
}

Response

This API will return a JSON payload re-stating the user’s new status in the alumni database.

Example

{
  "appStatus": "REJECTED"
}

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

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

Expected return

  • An error in case the system could not find or update the user or a success message in case the user was successfully opted out. This success message will be the new status the user will have.

Updated 21 days ago