{"_id":"570287e9747d6d0e0076ff4d","editedParams2":true,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":55,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"__v":6,"parentDoc":null,"editedParams":true,"category":{"_id":"558444cfafccfd0d00fcb2bc","pages":["558444cfafccfd0d00fcb2c0","558444cfafccfd0d00fcb2c1","558444cfafccfd0d00fcb2c2","558444cfafccfd0d00fcb2c3","55ad520e24cf160d0013587c","55ad522424cf160d0013587e","55ad52376aadf20d0015b788","55ad525433616a0d00599d59","55ad526333616a0d00599d5b","55ad526c24cf160d00135881","55d34302b9ef4435006dec83","55d349ca0168850d0073f099","55d34a4fb9ef4435006deca3","56aa8778cc0f740d005bc2c3","56d8ae52a957fb1500765aab","56eb0aceacc4bc0e00be05d1"],"__v":13,"project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-19T15:47:34.696Z","from_sync":false,"order":8,"slug":"users","title":"Users"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:27:37.155Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X PUT -H 'X-API-TOKEN: yourtokenhere'  -H 'Content-Type: application/json' -d '{\n    \"status\": \"active\",\n    \"lastName\": \"ExampleLastName\",\n    \"password\": \"uwillneverguess\",\n    \"firstName\": \"ExampleFirstName\",\n    \"userType\": \"UT_1234567890AbCdE\",\n    \"accountExpirationDate\": null,\n    \"permissions\": {\n        \"controlPanel\": {\n            \"accountPermissions\": {\n                \"accessApi\": {\n                    \"state\": \"off\"\n                }\n            }\n        }\n    }\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/users/UR_1234567890AbCdE'","name":""}]},"method":"put","results":{"codes":[{"name":"","code":"{\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55ad7551acbae419006f1b8d","ref":"","in":"path","required":true,"desc":"User ID","default":"","type":"string","name":"userId"},{"_id":"56a6ab5d2ec8310d007bc262","ref":"","in":"body","required":false,"desc":"New username (Must be a valid email.)","default":"","type":"string","name":"username"},{"_id":"55ad7551acbae419006f1b8c","ref":"","in":"body","required":false,"desc":"New password","default":"","type":"string","name":"password"},{"_id":"55ad7551acbae419006f1b8b","ref":"","in":"body","required":false,"desc":"New first name","default":"","type":"string","name":"firstName"},{"_id":"55ad7551acbae419006f1b8a","ref":"","in":"body","required":false,"desc":"New last name","default":"","type":"string","name":"lastName"},{"_id":"55ad7551acbae419006f1b89","ref":"","in":"body","required":false,"desc":"New account type","default":"","type":"string","name":"userType"},{"_id":"55ad7551acbae419006f1b88","ref":"","in":"body","required":false,"desc":"New division","default":"","type":"string","name":"divisionId"},{"_id":"55ad7551acbae419006f1b87","ref":"","in":"body","required":false,"desc":"New account status (active, disabled, notVerified)","default":"","type":"string","name":"status"},{"_id":"56d8a6c67a04df0b00ddf1f1","ref":"","in":"body","required":false,"desc":"The [language code](/docs/language-codes) to use for the user's account","default":"","type":"string","name":"language"},{"_id":"59b8614b4db70d002e7f6f47","ref":"","in":"body","required":false,"desc":"The [time zone](/docs/time-zones) setting for the new user's account","default":"","type":"string","name":"timeZone"},{"_id":"56d8a6c67a04df0b00ddf1f0","ref":"","in":"body","required":false,"desc":"New permissions values. This is an additive patch of the permissions given. States can be [on, off, userType]","default":"","type":"object","name":"permissions"},{"_id":"5733af2a7229db2000a6cae5","ref":"","in":"body","required":false,"desc":"Expiration date for the created user's account. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.","default":"","type":"yyyy-mm-dd","name":"accountExpirationDate"}],"url":"/v:version/users/:userId"},"isReference":false,"order":3,"body":"For more information about using the user APIs, see [Managing Users](doc:managing-users).\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Administrator Request\",\n  \"body\": \"To use this call you must be a Qualtrics brand administrator\"\n}\n[/block]","excerpt":"Updates a users information","slug":"update-user","type":"endpoint","title":"Update User"}

putUpdate User

Updates a users information

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

userId:
required
string
User ID

Body Params

username:
string
New username (Must be a valid email.)
password:
string
New password
firstName:
string
New first name
lastName:
string
New last name
userType:
string
New account type
divisionId:
string
New division
status:
string
New account status (active, disabled, notVerified)
language:
string
The [language code](/docs/language-codes) to use for the user's account
timeZone:
string
The [time zone](/docs/time-zones) setting for the new user's account
permissions:
object
New permissions values. This is an additive patch of the permissions given. States can be [on, off, userType]
accountExpirationDate:
yyyy-mm-dd
Expiration date for the created user's account. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.

Examples


Result Format


Documentation

For more information about using the user APIs, see [Managing Users](doc:managing-users). [block:callout] { "type": "warning", "title": "Administrator Request", "body": "To use this call you must be a Qualtrics brand administrator" } [/block]

User Information

Try It Out

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