Modifies a user

PUT {{baseUrl}}/settings/v3/users/:userId?idProperty=<string>

Modifies a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.

Request Params

KeyDatatypeRequiredDescription
idPropertystringThe name of a property with unique user values. Valid values are USER_ID(default) or EMAIL

Request Body

{"primaryTeamId"=>"<string>", "roleId"=>"<string>", "secondaryTeamIds"=>["<string>", "<string>"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;primaryTeamId&quot;:&quot;\u003cstring\u003e&quot;,&quot;roleIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;sendWelcomeEmail&quot;:&quot;\u003cboolean\u003e&quot;,&quot;roleId&quot;:&quot;\u003cstring\u003e&quot;,&quot;secondaryTeamIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;superAdmin&quot;:&quot;\u003cboolean\u003e&quot;}