v1

latestOpenAPI 3.0.22026-07-26286974.7 KB
Users

Create a new user

post/v1/users

Request body

namestring

The name of the new user.

emailstring required

The email address of the new user..

passwordstring

The password of the new user. Must be at least 6 characters.

srcstring

The signup source of the user, Information tab of the user profile. SRC can also be used as a custom value when creating users in your school. For example, if you use any unique identifiers to help manage your users in multiple external systems (such as unique IDs, tags, etc.), you can use the src field to keep this identifier associated with your user in Teachable.

Response

201 response

namestring nullable required

The name of the user.

emailstring required

The email address of the user.

rolestring required

The role of the user (e.g., student, owner, affiliate, author, custom, etc.). All newly created users will have the student role by default.

last_sign_in_ipstring nullable required

The last signin IP address of the user. If the user has not yet signed in to their account, the return value is null.

idinteger required

The unique ID of the user.