Call

This call will return a schema, that is a representation of what fields are available to use through the API endpoints, and what their possible or expected values are. Using this API makes it possible to copy said schema, fill it with real values, and create or update users.

Response

This API will return a payload in JSON format, listing all the fields that are API exposed in the alumni platform and the kind of value that is expected from it. For fields that require specific values, these values will be provided in the response as well.

Example

{
    "communicationEmailAddress": "Enter email||Enter mailbox domain",
    "company": "'Your Corp' OR 'My Corp' OR 'Our Corp' OR 'Their Corp' OR 'Her Corp' OR 'His Corp' OR 'Other'",
    "yearOfBirth": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
    "firstName": "String",
    "isSubscribedToNews": true,
    "lastName": "String",
    "location": {
      "country": "String",
      "city": "String",
      "state": "String"
    }
  }

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

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