API Reference
  1. EduSign API Next
  2. Students

Create a new student

post
https://ext.edusign.fr/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
length between 1 and 100

First name (required for creation). Max 100 characters.

string
required
length between 1 and 100

Last name (required for creation). Max 100 characters.

string

Email address. Max 128 characters.

string
length ≤ 20

Student phone number. Max 20 characters.

uri
length ≤ 255

URL or path to student photo. Max 255 characters.

string
length ≤ 128

Student file number or reference. Max 128 characters.

string
length ≤ 160

Name of the curriculum program. Max 160 characters.

string
length ≤ 64
deprecated

Deprecated legacy free-text company label stored on this student. Existing read and write behavior is retained. Prefer the Companies endpoints and companyId for shared company records. This text does not automatically create, attach, or update a company record. Max 64 characters.

tags
array of strings

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

tags
string
length ≤ 128

Your system's unique identifier for this record. Max 128 characters.

string
length ≤ 30

The name of the third-party system that owns this record's original ID. Max 30 characters. (e.g. Ypareo, Hyperplanning...)

string
length ≤ 20

NFC Edusign Badge ID assigned to the student. 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 5 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?