Skip to navigation
API ReferenceTemplates

CreateTemplate

CreateTemplate saves a template. Templates are identified by their content: saving the same entity, target and mappings again returns the template already saved, its name 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>.

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

Required on create. enum.defined_only = true

Allowed values:
targetenumOptional

Required on create. enum.defined_only = true

Allowed values:
namestringOptional<=255 characters

The template’s name, trimmed; may be empty.

mappingslist of objectsOptional

The fields, in stored order; on create each source once.

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.

Response

Success
templateobjectOptional
Template is a team's saved field selection for one entity and target.