Examplary
Start for free
Developer docs

Create user

POSThttps://api.examplary.ai/users

Create a new user in the workspace.

Request body

emailstring· email· pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$required
namestring· min length: 1· max length: 100

The user's full name. Ignored when first or last name is set.

firstNamestring· max length: 100

The user's first name

lastNamestring· max length: 100

The user's last name

rolestring· default: teacher

Allowed values:adminteacherstudentmember

sendInviteboolean· default: false

Whether to send an invitation email. Defaults to false.

metadataobject

Responses

400 — Validation Error

successbooleanrequired

Allowed values:false

errorarray any[]required
dataanyrequired

429 — Rate limit exceeded

Requirements

Rate limit

1000 requests per minute per user.

User roles

This endpoint requires the teacher, admin, or owner role to be present.

OAuth scopes

This endpoint requires the users:write scope to be present.