Planfix API contact.updateUserInfo: Difference between revisions
From Planfix
(Created page with "This function updates the information about the user's authentication in the system. Admin rights are required to execute this function: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="contact.updateUserInfo"> <account></account> <sid></sid> <contact> <id></id> <userid></userid> <general></general> <user> <password></password> <status></status> <email></email> <pic></pic> <notifyByEmail></not...") |
(→Go To) |
||
(One intermediate revision by the same user not shown) | |||
Line 38: | Line 38: | ||
|user.email || string|| email address|| | |user.email || string|| email address|| | ||
|- | |- | ||
|user.jabber || string|| | |user.jabber || string|| Jabber account|| used in the notification system | ||
|- | |- | ||
|user.notifyByEmail|| bool||receive notifications by email || setting this parameter to 1 (use) requires a filled '''email''' field | |user.notifyByEmail|| bool||receive notifications by email || setting this parameter to 1 (use) requires a filled '''email''' field | ||
Line 81: | Line 81: | ||
== Go To == | == Go To == | ||
*[[Planfix API:Contacts]] | *[[Planfix API:Contacts]] | ||
*[[Error codes]] | *[[Error codes XML API v1|Error codes]] | ||
*[[List of functions]] | *[[List of functions]] |
Latest revision as of 09:15, 6 March 2024
This function updates the information about the user's authentication in the system. Admin rights are required to execute this function:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.updateUserInfo">
<account></account>
<sid></sid>
<contact>
<id></id>
<userid></userid>
<general></general>
<user>
<password></password>
<status></status>
<email></email>
<pic></pic>
<notifyByEmail></notifyByEmail>
</user>
</contact>
<signature></signature>
</request>
Name | Type | Value | Note |
---|---|---|---|
id | int | contact identifier | |
userid | int | contact identifier for cases when it is used in the system on par with employees (task assignee, etc., as well as a custom contact type field) | |
general | int | contact number | |
user | information about the account used for logging in | ||
user.password | string | password | |
user.status | enum | status | see the list of acceptable values in the custom statuses section |
user.email | string | email address | |
user.jabber | string | Jabber account | used in the notification system |
user.notifyByEmail | bool | receive notifications by email | setting this parameter to 1 (use) requires a filled email field |
user.notifyByJabber | bool | receive notifications via jabber | setting this parameter to 1 (use) requires a filled jabber field |
user.notifyByPlanfix | bool | eceive notifications via the internal Planfix notification system | |
user.pic | string | base64encoded image | |
signature | string(32) | signature |
Result of successful function execution:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<contact>
<id></id>
</contact>
</response>
Name | Type | Value | Note |
---|---|---|---|
contact.id | int | contact identifier |
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>