Skip to main content
POST
Generate Test Link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
embeddable_ui_id
enum<string>
required

Unique identifier for the embeddable UI. Check the embeddable_ui_id for various IELTS and TOEFL task here

Available options:
IE-AC-W-01,
IE-AC-W-02,
IE-GT-W-01,
IE-GT-W-02,
TF-ES-W-01,
TF-ES-W-02,
TF-ES-W-03,
TF-ES-W-04,
TF-ES-W-05,
TF-IB-W-01,
TF-IB-W-02
Example:

"IE-GT-W-02"

institute_id
string | null

ID of the institute. Accepts null and blank values.

Example:

"inst_456"

teacher_id
string | null

ID of the teacher. Accepts null and blank values.

Example:

""

parent_id
string | null

ID of the parent. Accepts null and blank values.

Example:

""

student_id
string | null

ID of the student. Accepts null and blank values.

Example:

"123"

student_name
string | null

Name of the student. Accepts null and blank values.

Example:

"crazygoldfish"

Response

Test link generated successfully.

embeddable_ui_requested
string

The generated test link.

Example:

"https://mock-test.crazygoldfish.com/exam/<unique_id>/?client_id=1"

client_id
integer

Client Id

Example:

1

institute_id
string

Institute Id

Example:

"inst_456"

teacher_id
string

Teacher Id

Example:

""

parent_id
string

Parent Id

Example:

""

student_id
string

Student Id

Example:

"123"

student_name
string

Student Name

Example:

"crazygoldfish"