Validate user schema JSON (POST)
This API allows you to validate that the user schema you will use to create or update users in the alumni platform is valid and won’t generate errors during your calls, allowing you to verify without affecting real data.
Call
In this call, you will be able to send the schema with the fields you wish to use to create or update users with their possible values. Also, it is possible to use the “disabledRequiredFields” flag, which will disable the system validation for required fields if true, making it possible for you to perform calls without including all the required fields, the default value for this flag is FALSE.
Notes
- The user JSON schema payload must be populated as it is returned on the user schema API.
- Required fields cannot be sent with empty values even if the field "disable required fields" is set as true".
- Even if "disable required fields" is set as "true" the system will check the mandatory fields: first name, last name, and email address.
- By default, the API will check if the required fields are populated in the payload.
- To disable the required fields the value to be passed in “disable required fields” is “true”.
- A user can be created without all the required fields being populated (except first name, last name and email address). In this case, the user can finish filling in all his information once he signs up.
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.
- For a Successful call:
{}- For a call where a fake field was added:
{
"message": "{\"message\":\"Error while validating User Schema\",\"errors\":[\"#: extraneous key [fakeField] is not permitted\"]}"
}*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.
Updated 22 days ago