As a Campus Cloud administrator, you can get a list of campuses used in the app. The Campus endpoint gives access to this information and returns a list of campus names and their ID's.
You can use a campus ID number with the push notification endpoint to send a message to all users within a campus.
You will need an API key. Follow the steps in this FAQ:
Make sure to enable to Campus endpoint.
Once you have generated an API key, your school can send messages to all users within a campus as follows:
- Use the Campus endpoint to determine the ID of the target campus
- Use the push notification endpoint to send your message to that campus ID.
Your notification appears in the notification centre of users signed in to the target campus.
For more information, please see:
- Ready Application Programming Interface (API) Overview
- Ready API Technical Documentation (opens in a new window)