Skip to navigation
API ReferenceLists

CreateListItem

CreateListItem adds an institution to a list; a list holds at most 1,000. Adding one already on the list returns it unchanged.

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>.

Path parameters

list_idstringRequiredformat: "uuid"1-36 characters
Identifier of the list to add to.

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.
list_idstringOptional<=36 characters
Identifier of the list it is on.
institution_idstringOptionalformat: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"<=36 characters

The institution, a lower-case UUID; required on create.

create_timedatetimeOptional
When Edulead created the resource.

Response

Success
list_itemobjectOptional

ListItem is one institution on a list; its id is the institution’s.