Create group
Request description
Endpoint: /users/groups/create
Method: POST
Header
{
"Content-Type": "application/json",
"Authorization": "Bearer <accessToken>"
}
Note: the <accessToken> is obtained as a result of the authentication
Payload
{
"name": "mock-group-name"
}
Payload structure
type CreateGroupPayloadType = {
name: string // Group name
}
Responses
Correct response
Successful request
Describe the characteristics of a satisfactory response
201
Response structure:
{
// empty response
}
Wrong responses
Unauthorized request
Describe the characteristics of an unauthorized request
401
Response body
{
// empty body
}
Description: this error occurs when endpoint authorizers fail to validate the token sent in the request header.
Bad request
Describe the characteristics of a bad request
400
Response body
type CreateGroupResponseType = {
errorType: CREATE_GROUP_ERROR_TYPE,
errorMessage?: string
}
enum CREATE_GROUP_ERROR_TYPE {
REQUIRED_GROUP_NAME= 'requiredGroupName'
GROUP_NAME_ALREADY_EXISTS= 'groupNameAlreadyExists'
}