Skip to navigation
API ReferenceBeacons

CreateBeacon

CreateBeacon adds an empty beacon; the team must be under its NR_BEACONS__TOTAL limit. The same request_id returns the beacon it made.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Headers

Edulead-TeamstringRequired

Query parameters

request_idstringOptional1-64 characters

Caller-chosen idempotency key. The same key from the same caller within 24 hours returns the original result instead of acting again.

Request

This endpoint expects an object.
idstringOptional<=36 characters
Identifier of the resource, assigned by Edulead and opaque to callers.
namestringOptional<=100 characters

The beacon’s name, trimmed; required on create and when updated. Names need not be unique.

institution_countintegerOptional
How many institutions the beacon holds. Output only.
creator_idstringOptional<=255 characters
The user or API key that created it.
create_timedatetimeOptional
When Edulead created the resource.
update_timedatetimeOptional
When any field last changed.
colorstringOptionalformat: "^(|color:[a-z]+-[0-9]{1,3})$"<=32 characters

The beacon’s colour on the map, or empty for the app’s default: a scheme and a value, for now color:<name>-<shade> naming the app’s palette (color:orange-80); a hex: scheme may follow.

Response

Success
beaconobjectOptional

Beacon is a named list of institutions. update_time moves on every change of the name or the institutions.