The users APIS are used to create and maintain users. Characteristically a user can be made an administrator of a chatbot by setting its “isAdmin” field to “true”. If Its value is “false” the user can chat with the chatbot but cannot create other users.
The following APIS are used to create and manage users:
- Register user API. This API is used to register or create a user for a chatbot.
- Update user API. This API is used to update the fields of a user.
- Delete user API. This API is used to delete a user that is no longer needed.
- Query user API. This API will query one user and will return all the values of the fields of the user.
- Query All users API. This API will return all users for a particular chatbot as a list of users with all of their corresponding field values.
- Login API. This API will if succesful return a user object. The API can be used to validate a login attempt by a user.
The apis are all of the POST type and uses a JSON body. To subscribe to the APIS please visit the GWOCU website.