API Basics

EnterpriseAlumni APIs are a set of rules and protocols that allow you to create communication streams from third-party software to your alumni platform. For this, we used standard request types to accommodate any possible use case.

Request	Synonym	Description
POST	Create	The POST method is used to create a new resource on the alumni platform. When you send a POST request to any endpoint, you request the application to process the data provided in the request payload and create a new resource based on that data. In EnterpriseAlumni APIs you can find this kind of request in the Create a new event endpoint.
GET	Read	The GET method is used to retrieve information or resources from the alumni platform. When you send a GET request to an API endpoint, you request the server retrieve and return the specified resource or a collection of resources. This is the most commonly used request type for fetching data from an API. In EnterpriseAlumni APIs you can find this kind of request in the Search User endpoint.
PUT	Update	The PUT method is used to update an existing resource on the alumni platform. When you send a PUT request to an API endpoint, you are providing data in the request payload that represents the updated version of the resource. The server replaces the existing resource with the updated data. PUT requests are idempotent, meaning that making multiple identical requests will have the same result as a single request. In EnterpriseAlumni APIs you can find this kind of request in the Update an event endpoint.
DELETE	Delete	The DELETE method is used to remove a resource from the alumni platform. When you send a DELETE request to an API endpoint, you request the server delete the specified resource. After a successful DELETE request, the resource will no longer be available on the server. Like PUT requests, DELETE requests are also idempotent. In EnterpriseAlumni APIs you can find this kind of request in the Delete User endpoint.