{"_id":"547fb2feb7c1e40800dcf539","category":{"_id":"546b909462515a14007ebc43","project":"545137a814af501a00b50cf9","pages":["546fdf54a179880800187e8b","54738e24007eb108007e03ff","54738e7d1a20c70800e189b0","54738e8a007eb108007e0404","54738e9b1a20c70800e189b2","54738ec0007eb108007e0407","54738ed21a20c70800e189b5","54738ee2007eb108007e0414","54738f05007eb108007e0416","54738f23007eb108007e0418","54738f31007eb108007e041a","547f80f9b7c1e40800dcf46f","547f9758b7c1e40800dcf4c2","547f9a3f3031bc0800e5fec4","547fa5f63031bc0800e5fef3","547fa632b7c1e40800dcf4e9","547fa696b7c1e40800dcf4ec","547fa6cc3031bc0800e5fef6","547fab89b7c1e40800dcf511","547facedb7c1e40800dcf51f","547faeef3031bc0800e5ff2d","547fafb03031bc0800e5ff31","547fb05ab7c1e40800dcf52a","547fb07a3031bc0800e5ff38","547fb0c4b7c1e40800dcf531","547fb100b7c1e40800dcf535","547fb18c3031bc0800e5ff41","547fb2433031bc0800e5ff44","547fb2feb7c1e40800dcf539","547fb335b7c1e40800dcf53b","547fb4aa3031bc0800e5ff49","547fb4f4b7c1e40800dcf541","547fb553b7c1e40800dcf544","54809ecd5f83dd0800c38fd3","54809f715f83dd0800c38fd6","54809fa8a3e4ea22000976b7","54809fd3a3e4ea22000976ba","5480a00ba3e4ea22000976bc","5480f44dea7fd40b00cd7c06","5480f4fb0e664d0b00be35f9","5480f5a5ea7fd40b00cd7c0b","5480f607ea7fd40b00cd7c10","5480f657ea7fd40b00cd7c12","5480f69a0e664d0b00be35ff","5480f77aea7fd40b00cd7c14","5480f7e7ea7fd40b00cd7c18","5480f83dea7fd40b00cd7c1b","5480f950ea7fd40b00cd7c1e","5480f9a6ab84321d00eaf538","5480faa8ea7fd40b00cd7c22","5480fb0aea7fd40b00cd7c25","5480fbd8ea7fd40b00cd7c27","5480fc64ab84321d00eaf53c","54c01ec89290010d00934956","55581594e54fe019002a4f2c","556e8b29fc3aa80d00e1a953"],"version":"545137a814af501a00b50cfc","__v":56,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2014-11-18T18:31:48.943Z","from_sync":false,"order":2,"slug":"rest-api","title":"REST API"},"user":"5433099f9a2b451a00ad4531","__v":3,"editedParams2":true,"editedParams":true,"version":{"_id":"545137a814af501a00b50cfc","project":"545137a814af501a00b50cf9","__v":11,"createdAt":"2014-10-29T18:53:28.525Z","releaseDate":"2014-10-29T18:53:28.525Z","categories":["545137a814af501a00b50cfd","545138eaa66f020800dbab4a","546b9072b47b5d1400109edf","546b9082b47b5d1400109ee0","546b9088b47b5d1400109ee1","546b909462515a14007ebc43","546b90a0b47b5d1400109ee2","546ced235884600e007a92f6","5481008eea7fd40b00cd7c2b","573b9d83ee2b3b220042291f","57be1efa15efc70e006a5f99"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","parentDoc":null,"project":"545137a814af501a00b50cf9","updates":["580fcf80c03f0b0f0097f077","583d671e2c67913700a86058"],"next":{"pages":[],"description":""},"createdAt":"2014-12-04T01:03:58.937Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","try":true,"basic_auth":false,"examples":{"codes":[]},"method":"post","auth":"required","params":[{"_id":"547fb2feb7c1e40800dcf53a","ref":"","in":"body","required":true,"desc":"The ID of the group","default":"","type":"int","name":"group_id"},{"_id":"56c1eadd8073830d00e42df2","ref":"","in":"body","required":false,"desc":"The ID of the user to add to the group","default":"","type":"int","name":"user_id"},{"_id":"56c1eadd8073830d00e42df1","ref":"","in":"body","required":false,"desc":"The email of the user to add to the group","default":"","type":"string","name":"email"}],"url":"/group_memberships.json"},"isReference":true,"order":21,"body":"Join the group specified by the `group_id`.  If neither `user_id` or `email` is provided then the user that is currently authenticated will be added to the group.  \n\nIf the `email` does not correspond to an existing user then as well as being invited to join the group the user will be invited to join the network.  For this to work the current user must have sufficient permissions to invite a user to the network (e.g. on a moderated network the current user must be a network admin).\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"WARNING!\",\n  \"body\": \"The API Explorer (\\\"Try It\\\") will POST to your home Yammer network.\"\n}\n[/block]","excerpt":"","slug":"group_membershipsjsongroup_idid","type":"endpoint","title":"/group_memberships.json"}

post/group_memberships.json


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

group_id:
required
integer
The ID of the group
user_id:
integer
The ID of the user to add to the group
email:
string
The email of the user to add to the group

Documentation

Join the group specified by the `group_id`. If neither `user_id` or `email` is provided then the user that is currently authenticated will be added to the group. If the `email` does not correspond to an existing user then as well as being invited to join the group the user will be invited to join the network. For this to work the current user must have sufficient permissions to invite a user to the network (e.g. on a moderated network the current user must be a network admin). [block:callout] { "type": "danger", "title": "WARNING!", "body": "The API Explorer (\"Try It\") will POST to your home Yammer network." } [/block]

User Information

Note: Do not use this token in your app; you'll need to get the OAuth token yourself.

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}