Skip to main content
POST
Add a user to a group

Authorizations

Authorization
string
header
default:Token token=<api-key>
required

API authentication using your community API secret. The value below is sent as the Authorization header verbatim, so paste the whole header value including the prefix: Token token=

Path Parameters

uuid
string
required

The group UUID

Body

application/json

Payload wrapped in a user object

user
object
required

Response

The user was added to the group, or the user type does not match the group type

message
string
Example:

"User jane@example.com added to group Engineering with UUID abc-123"

errors
string

Present instead of message when the user could not be added to the group

Example:

"User type does not match group type"