API Reference

[BETA] Create a new student

post
https://api.edusign.com/v3/students

Create a single student.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
string
string

Student phone number. Max 20 characters.

string

URL or path to student photo. Max 255 characters.

string

Student file number or reference. Max 128 characters.

string

Name of the curriculum program. Max 160 characters.

string

Company associated with the student. Max 64 characters.

tags
array of strings

Custom tags. Max 15 tags, each max 35 characters.

tags
string

Unique external reference. New version of apiId. Max 64 characters.

string

External reference type. Used to identify the external system that created the student. Used by Edusign connectors Max 30 characters. (e.g. Ypareo, Hyperplanning...)

string

ID of the student badge. Max 20 characters.

boolean

Whether the student needs to set a new password

boolean
Defaults to false

Whether to send login credentials email to the student. If true, email is required.

Responses

Updated 4 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago