{"_id":"5480fb0aea7fd40b00cd7c25","editedParams":true,"githubsync":"","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"},"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","editedParams2":true,"project":"545137a814af501a00b50cf9","__v":4,"parentDoc":null,"updates":["592878aa94d9382f0096d030","5c37fea8d37ca441ec5ea04d"],"next":{"pages":[],"description":""},"createdAt":"2014-12-05T00:23:38.127Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"post","results":{"codes":[]},"try":true,"examples":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5480fb0aea7fd40b00cd7c26","ref":"","in":"body","required":false,"desc":"The email address of the user being invited. This can be specified multiple times to invite multiple users, or using email1 through email20.","default":"","type":"string","name":"email"},{"_id":"5c38d56c2c3be20013e565c5","ref":"","in":"body","required":false,"desc":"[optional] Group to add the user to","default":"JSON","type":"int","name":"group_id"}],"url":"/invitations.json"},"isReference":true,"order":45,"body":"Invites a user to the current user’s Yammer network.\n\nSends an email invitation to a user who has not yet joined the current user’s yammer network. If the current user is a verified admin in a paid yammer network that supports guest users, users with external email domains can be added. If the current user is not, only email addresses for official company domains will be allowed.\n\nOptionally specify a group ID to add the user(s) to a group at the same time as issuing the invite.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Dynamic Groups Management\",\n  \"body\": \"[Dynamic Groups](https://support.office.com/en-us/article/Dynamic-groups-in-Yammer-6d2a6ec7-1d65-46bb-b253-1bf441ec80a5) are now supported in Yammer. This will prevent invitations from this API as those members are managed in Azure AD. \\n\\nThe API will return a 400 error code with the following response body\\n```json\\n{\\n  \\\"message\\\": \\\"Error: Unable to modify membership to group with dynamic membership\\\",\\n  \\\"code\\\": \\\"dynamic_group_membership_change_error\\\"\\n}\\n```\"\n}\n[/block]\n\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":"invitationsjson","type":"endpoint","title":"/invitations.json"}

post/invitations.json


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

email:
string
The email address of the user being invited. This can be specified multiple times to invite multiple users, or using email1 through email20.
group_id:
integerJSON
[optional] Group to add the user to

Documentation

Invites a user to the current user’s Yammer network. Sends an email invitation to a user who has not yet joined the current user’s yammer network. If the current user is a verified admin in a paid yammer network that supports guest users, users with external email domains can be added. If the current user is not, only email addresses for official company domains will be allowed. Optionally specify a group ID to add the user(s) to a group at the same time as issuing the invite. [block:callout] { "type": "warning", "title": "Dynamic Groups Management", "body": "[Dynamic Groups](https://support.office.com/en-us/article/Dynamic-groups-in-Yammer-6d2a6ec7-1d65-46bb-b253-1bf441ec80a5) are now supported in Yammer. This will prevent invitations from this API as those members are managed in Azure AD. \n\nThe API will return a 400 error code with the following response body\n```json\n{\n \"message\": \"Error: Unable to modify membership to group with dynamic membership\",\n \"code\": \"dynamic_group_membership_change_error\"\n}\n```" } [/block] [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 }}