{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users.json","auth":"required","basic_auth":false,"method":"post","params":[{"name":"email","type":"string","default":"","desc":"Email for new user","required":false,"in":"body","ref":"","_id":"54c7d1f6d0d3360d0081c53d"},{"name":"full_name","type":"string","default":"","desc":"Full name of user","required":false,"in":"body","ref":"","_id":"54c7d1f6d0d3360d0081c53c"},{"name":"job_title","type":"string","default":"","desc":"Job title for the new user","required":false,"in":"body","ref":"","_id":"605d0df59ea12c002cd09ef5"},{"name":"department_name","type":"string","default":"","desc":"Department name for the new user","required":false,"in":"body","ref":"","_id":"605d0df59ea12c002cd09ef6"},{"name":"location","type":"string","default":"","desc":"Location for the new user","required":false,"in":"body","ref":"","_id":"605d0df59ea12c002cd09ef7"},{"name":"mobile_telephone","type":"string","default":"","desc":"Mobile telephone number for the new user","required":false,"in":"body","ref":"","_id":"605d0df59ea12c002cd09ef8"},{"name":"summary","type":"string","default":"","desc":"Summary for the new user. Typically used for a bio or description.","required":false,"in":"body","ref":"","_id":"605d0df59ea12c002cd09ef9"}],"results":{"codes":[]},"try":true,"examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"/users.json","type":"endpoint","slug":"usersjson-1","excerpt":"","body":"The users endpoint can be used to create new users in a Yammer network. It is strongly recommended that users are added through [Microsoft 365 Admin Portal](https://docs.microsoft.com/en-us/microsoft-365/enterprise/manage-microsoft-365-accounts?view=o365-worldwide), [Azure AD PowerShell](https://docs.microsoft.com/en-us/powershell/module/azuread/?view=azureadps-2.0), [Azure AD Portal](https://azure.microsoft.com/en-us/features/azure-portal/), [Bulk Update](https://docs.microsoft.com/en-us/yammer/manage-yammer-users/add-block-or-remove-users), etc. instead of through this endpoint.\n\nThe behavior of this endpoint is dependent on factors, including:\n\n- Whether the network is in [Native Mode]([http://google.com](https://docs.microsoft.com/en-us/yammer/configure-your-yammer-network/overview-native-mode)), or not.\n- If the network is enterprise or freemium (basic.)\n- Whether the user is a [verified admin](https://docs.microsoft.com/en-us/yammer/manage-yammer-users/manage-yammer-admins), or not.\n- If the token passed to this endpoint is associated with a canonical (home) network, or an external network.\n- Type of email passed to this endpoint (work versus personal.)\n- [Data residency](https://docs.microsoft.com/en-us/yammer/manage-security-and-compliance/data-residency) of the Yammer network.\n\nOver time all Yammer networks will transition to Native Mode and all user creation and updates will occur via Azure Active Directory.\n\n### Additional legacy parameters ###\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"im_provider\",\n    \"1-0\": \"im_username\",\n    \"2-0\": \"work_telephone\",\n    \"3-0\": \"work_extension\",\n    \"4-0\": \"external_profiles\",\n    \"5-0\": \"significant_other\",\n    \"6-0\": \"kids_names\",\n    \"7-0\": \"interests\",\n    \"8-0\": \"expertise\",\n    \"9-0\": \"education\",\n    \"9-1\": \"accepts multiple attributes i.e. education[]=UCLA,BS,Economics,1998,2002&education[]=USC,MBA,Finance,2002,2004\",\n    \"10-0\": \"previous_companies\",\n    \"10-1\": \"accepts multiple attributes i.e. previous_companies[]=Geni.com,Engineer,2005,2008\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]","updates":[],"order":32,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54809fa8a3e4ea22000976b7","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["545137a814af501a00b50cfd","545138eaa66f020800dbab4a","546b9072b47b5d1400109edf","546b9082b47b5d1400109ee0","546b9088b47b5d1400109ee1","546b909462515a14007ebc43","546b90a0b47b5d1400109ee2","546ced235884600e007a92f6","5481008eea7fd40b00cd7c2b","573b9d83ee2b3b220042291f","57be1efa15efc70e006a5f99","5ee004f52c97b4004c7a5876"],"_id":"545137a814af501a00b50cfc","project":"545137a814af501a00b50cf9","__v":12,"createdAt":"2014-10-29T18:53:28.525Z","releaseDate":"2014-10-29T18:53:28.525Z"},"__v":10,"user":"5433099f9a2b451a00ad4531","githubsync":"","project":"545137a814af501a00b50cf9","category":{"sync":{"isSync":false,"url":""},"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"],"title":"REST API","slug":"rest-api","order":2,"from_sync":false,"reference":true,"_id":"546b909462515a14007ebc43","project":"545137a814af501a00b50cf9","version":"545137a814af501a00b50cfc","__v":56,"createdAt":"2014-11-18T18:31:48.943Z"},"editedParams2":true,"parentDoc":null,"createdAt":"2014-12-04T17:53:44.235Z","editedParams":true}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

email:
string
Email for new user
full_name:
string
Full name of user
job_title:
string
Job title for the new user
department_name:
string
Department name for the new user
location:
string
Location for the new user
mobile_telephone:
string
Mobile telephone number for the new user
summary:
string
Summary for the new user. Typically used for a bio or description.

Documentation

The users endpoint can be used to create new users in a Yammer network. It is strongly recommended that users are added through [Microsoft 365 Admin Portal](https://docs.microsoft.com/en-us/microsoft-365/enterprise/manage-microsoft-365-accounts?view=o365-worldwide), [Azure AD PowerShell](https://docs.microsoft.com/en-us/powershell/module/azuread/?view=azureadps-2.0), [Azure AD Portal](https://azure.microsoft.com/en-us/features/azure-portal/), [Bulk Update](https://docs.microsoft.com/en-us/yammer/manage-yammer-users/add-block-or-remove-users), etc. instead of through this endpoint. The behavior of this endpoint is dependent on factors, including: - Whether the network is in [Native Mode]([http://google.com](https://docs.microsoft.com/en-us/yammer/configure-your-yammer-network/overview-native-mode)), or not. - If the network is enterprise or freemium (basic.) - Whether the user is a [verified admin](https://docs.microsoft.com/en-us/yammer/manage-yammer-users/manage-yammer-admins), or not. - If the token passed to this endpoint is associated with a canonical (home) network, or an external network. - Type of email passed to this endpoint (work versus personal.) - [Data residency](https://docs.microsoft.com/en-us/yammer/manage-security-and-compliance/data-residency) of the Yammer network. Over time all Yammer networks will transition to Native Mode and all user creation and updates will occur via Azure Active Directory. ### Additional legacy parameters ### [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "0-0": "im_provider", "1-0": "im_username", "2-0": "work_telephone", "3-0": "work_extension", "4-0": "external_profiles", "5-0": "significant_other", "6-0": "kids_names", "7-0": "interests", "8-0": "expertise", "9-0": "education", "9-1": "accepts multiple attributes i.e. education[]=UCLA,BS,Economics,1998,2002&education[]=USC,MBA,Finance,2002,2004", "10-0": "previous_companies", "10-1": "accepts multiple attributes i.e. previous_companies[]=Geni.com,Engineer,2005,2008" }, "cols": 2, "rows": 11 } [/block]