- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- User tasks
User update
Function
The UserUpdate task updates the data of a user.
Description
Route: PUT /user/{name}/{context}
{
"defaultEmail": "customersub1@example.de",
"status": 1,
"substatus": 2,
"details": {
"passwordResetMobile": "+49-34634-638",
"fname": "John",
"lname": "Doe"
},
"language": "de",
"parent": {
"context": 4,
"user": "customer"
}
}{
"stid": "20211104-app-90121",
"status": {
"code": "S1301002",
"text": "User was updated successfully.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "customersub1, 4",
"data": {
"context": 4,
"user": "customersub1"
}
}
}
Task code: 1301002
Uses User object
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>1301002</code>
<user>
<user>customersub1</user>
<context>104</context>
<password>password</password>
<status>2</status>
<substatus>2</substatus>
<default_mail>customersub1@example.de</default_mail>
<language>de</language>
</user>
</task>
</request><response>
<result>
<data/>
<status>
<code>S1301002</code>
<text>User was updated successfully.</text>
<type>success</type>
<object>
<type>user</type>
<value>customersub1, 4</value>
</object>
</status>
</result>
<stid>20211104-app-7088</stid>
</response>Update by a parent user
<request>
<auth>
<user>customer1</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>1301002</code>
<user>
<context>4</context>
<user>customer2</user>
<language>en</language>
<default_mail>customer2@example.com</default_mail>
<status>2</status>
<substatus>2</substatus>
<owner>
<user>customer1</user>
<context>4</context>
</owner>
</user>
<ctid></ctid>
<reply_to>customer2@example.com</reply_to>
<confirmmail>true</confirmmail>
</task>
</request><response>
<result>
<data/>
<status>
<code>S1301002</code>
<text>User was updated successfully.</text>
<type>success</type>
<object>
<type>user</type>
<value>customer2, 4</value>
</object>
</status>
</result>
<stid>20211104-app-6348</stid>
</response>Example with optional <user_mail_key> key
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>1301002</code>
<user>
<user>subuser</user>
<context>4</context>
<password>password</password>
<status>2</status>
<substatus>2</substatus>
<default_mail>EMAIL</default_mail>
<language>en</language>
<user_mail_keys>
<user_mail_key>
<public_key><![CDATA[-----BEGIN PGP PUBLIC KEY BLOCK----- ... -----END PGP PUBLIC KEY BLOCK-----]]></public_key>
<fingerprint><![CDATA[bc295893f3ec94ac9fb5c7530b0b7b8ad42d76]]></fingerprint>
<type>PGP</type>
</user_mail_key>
</user_mail_keys>
</user>
</task>
</request><response>
<result>
<data/>
<status>
<code>S1301002</code>
<text>User was updated successfully.</text>
<type>success</type>
<object>
<type>user</type>
<value>subuser, 4</value>
</object>
</status>
</result>
<stid>20211104-app-856</stid>
</response>