Instructors

Endpoints for working with instructors.

Get instructors

GET /api/internal/v1/partners/:partner_id/instructors

Get the instructors of the given partner.

Path Parameters

Name	Type	Description
partner_id	integer	The ID of the partner.

Query Parameters

Name	Type	Description
page	integer	The current page. Defaults to 1.
search	string	Filter instructors by name and email.

200

Create a new instructor

POST /api/internal/v1/partners/:partner_id/instructors

Create a new instructor for the given partner.

Path Parameters

Name	Type	Description
partner_id	integer	The ID of the partner.

Request Body

Name	Type	Description
name	string	The name of the instructor.
email	string	The email address of the instructor.
note	string	Internal note regarding the instructor.
display_phone_number	boolean	Indicates if the instructor phone number should be visible in the online profile. Default is false.
display_email	boolean	Indicates if the instructor email address should be visible in the online profile. Default is true.
website	string	The instructor website link.
facebook_link	string	The Facebook profile link of the instructor.
youtube_link	string	The Youtube profile link of the instructor.
twitter_link	string	The Twitter profile link of the instructor.
profile_image	object	The profile image of the instructor.
category_ids	array	Array with the IDs of the categories that should be associated with the instructor.

200

Get a specific instructor

GET /api/internal/v1/partners/:partner_id/instructors/:instructor_id

Get a specific instructor.

Path Parameters

Name	Type	Description
partner_id	integer	The ID of the partner.
instructor_id	integer	The ID of the instructor.

200

Update instructor

PUT /api/internal/v1/partners/:partner_id/instructors/:instructor_id

Update the given instructor. The fields used when creating a new instructor are also applied here.

Path Parameters

Name	Type	Description
partner_id	integer	The ID of the partner.
instructor_id	integer	The ID of the instructor.

200

Delete instructor

DELETE /api/internal/v1/partners/:partner_id/instructors/:instructor_id

Delete the given instructor.

Path Parameters

Name	Type	Description
partner_id	integer	The ID of the partner.
instructor_id	integer	The ID of the instructor to be deleted.

200

Update instructor profile image

PUT /api/internal/v1/partners/:partner_id/instructors/:instructor_id/profile-image

Update the profile image of the given instructor.

Path Parameters

Name	Type	Description
partner_id	integer	The ID of the partner.
instructor_id	integer	The ID of the instructor.

Request Body

Name	Type	Description
profile_image	object	The image to be uploaded.

200

Delete instructor profile image

DELETE /api/internal/v1/partners/:partner_id/instructors/:instructor_id/profile-image

Delete the profile image of the given instructor.

Path Parameters

Name	Type	Description
partner_id	integer	The ID of the partner.
instructor_id	integer	The ID of the instructor.

200