Invites users as members of a user-group. Only user-group admins and system admins are allowed. If mailing is enabled (see mail setting), email invitations to join the group are sent to the users listed as members. Membership status PENDING is assigned to these users.

Available in: full version

Method: POST

Service URL: root/group/member/invite

Header Parameters

Request body

A JSON object with the following attributes:

Request example with cURL:

curl -H "Content-Type: application/json" 
     -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MTM1MzI3O
       TAxMzQsInN1YiI6InVzZXJuYW1lIiwiaXNzIjoiaHR0cDpcL1wva29yYXAuaWRzLW1
       hbm5oZWltLmRlIn0.p4jHIGeVwTpYAPFiWAd0R8Zcazyg7e9_tUGxOyFGUlo' 
      -d '{"id": 5,"members": ["pearl, tad"]}'
      http://localhost:8089/api/group/member/invite

Request example with Basic authentication (for testing only):

curl -H "Content-Type: application/json" 
     -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 
      -d '{"id": 5,"members": ["pearl, tad"]}'
      http://localhost:8089/api/group/member/invite