Forum Discussion

mkuehnkhoros's avatar
mkuehnkhoros
Ace
5 years ago

Bulk Add Users to Group Hubs via API Calls?

Is there any way to programmatically bulk add users to multiple group hubs using API calls?Ideally, I'd like to take a CSV data with columns "group_hub_id, user_id, role" and iterate over it, adding ...
  • allensmith81's avatar
    allensmith81
    5 years ago

    Hi mkuehnkhoros 

    Some good news on this, you can actually do this, but you have to bypass the membership API in v2.

    You essentially need to call the APIv1 endpoint and add users i.e:

    https://yourcommunity.com/restapi/vc/roles/id/<roleid>/users/add?role.user=id/<userid>&restapi.session_key=<apiKey>

you can use other varients of this but in my example above lest assume we want to add user 52 to the owner role for Group Hub MyHub, which has a role id of 216.

You would make a post call like this:
https://yourcommunity.com/restapi/vc/roles/id/216/users/add?role.user=id/52&restapi.session_key=dkldjlkfjgdlkfjdflkjg4989438u

     

     

allensmith81's avatar
allensmith81
Boss
5 years ago

Hi mkuehnkhoros 

Some good news on this, you can actually do this, but you have to bypass the membership API in v2.

You essentially need to call the APIv1 endpoint and add users i.e:

https://yourcommunity.com/restapi/vc/roles/id/<roleid>/users/add?role.user=id/<userid>&restapi.session_key=<apiKey>

you can use other varients of this but in my example above lest assume we want to add user 52 to the owner role for Group Hub MyHub, which has a role id of 216.

You would make a post call like this:
https://yourcommunity.com/restapi/vc/roles/id/216/users/add?role.user=id/52&restapi.session_key=dkldjlkfjgdlkfjdflkjg4989438u

 

 

  • mkuehnkhoros's avatar
    mkuehnkhoros
    Ace
    5 years ago

    Thanks for the information! This may be just what we need.

  • Claudius's avatar
    Claudius
    Boss
    2 years ago

    allensmith81 How do I obtain the role ID of a group hub membership role? I know for normale community roles I can get it from the role admin links, but I can't find an equivalent for group hub roles

    • JoshuaBr's avatar
      JoshuaBr
      Khoros Staff
      2 years ago

      Hi Claudius,

      Using APIv2 you could run a query such as

      SELECT id FROM roles WHERE node.id = 'grouphub:welcome_center' AND users.id = '15665'

       and in the results you would see the IDs for that user for that grouphub.  From the test I ran, here is a snippet of the results:

      "items" : [ {
      "type" : "role",
      "id" : "g:welcome_center:Member"

       

      User 15665 is has a role id of "g:welcome_center:Member" for the Grouphub "welcome_center".

      If you're looking to get all the possible roles for the Grouphub, simply remove the users.id constraint, like so

      SELECT id FROM roles WHERE node.id = 'grouphub:welcome_center'

      and you'll see results such as

          "items" : [ {
      "type" : "role",
      "id" : "g:welcome_center:Curator"
    }, {
      "type" : "role",
      "id" : "g:welcome_center:Inviter"
    }, {
      "type" : "role",
      "id" : "g:welcome_center:Member"
    }, {
      "type" : "role",
      "id" : "g:welcome_center:Owner"
    } ]