ПланФикс API contact.update
Материал из Planfix
Функция обновления информации о клиенте. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.update">
<account></account>
<sid></sid>
<silent></silent>
<contact>
<id></id>
<general></general>
<name></name>
<midName></midName>
<lastName></lastName>
<template></template>
<post></post>
<email></email>
<phones>
<phone>
<number></number>
<typeId></typeId>
<typeName></typeName>
</phone>
<!-- ... -->
</phones>
<secondaryEmails>
<email></email>
<!-- ... -->
</secondaryEmails>
<address></address>
<description></description>
<sex></sex>
<site></site>
<skype></skype>
<facebook></facebook>
<vk></vk>
<icq></icq>
<birthdate></birthdate>
<lang></lang>
<canBeWorker></canBeWorker>
<canBeClient></canBeClient>
<group>
<id></id>
</group>
<customData>
<customValue>
<id></id>
<value></value>
</customValue>
<!-- ... -->
</customData>
<responsible>
<users>
<id></id>
<id></id>
<!-- ... -->
</users>
<groups>
<id></id>
<id></id>
<!-- ... -->
</groups>
</responsible>
</contact>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
silent | bool | при значении 1 - об изменении не рассылаются уведомления, не создаются действия и записи в логе контакта | обязательно значение 1 при массовых периодических обновлениях контактов |
id | int | идентификатор обновляемого контакта | |
general | int | номер обновляемого контакта (используется если не задан id) | |
name | string | Имя | |
midName | string | Отчество | |
lastName | string | Фамилия | |
template | int | номер шаблона контакта, (general в результатах contact.getList) | необязательный, при отсутствии не изменяется |
post | string | Должность | |
string | адрес электронной почты | ||
phones | string | телефоны | |
phone.number | string | номер телефона | |
phone.typeId | int | идентификатор типа номера | допустимые значения можно получить функцией contact.getPhoneTypes |
phone.typeName | string | название типа номера | |
secondaryEmails | string | дополнительные адреса email | |
secondaryEmails.email | string | ||
address | string | Адрес | |
description | string | Дополнительная информация | |
sex | enum | пол | допустимые значения смотри в разделе пол клиента |
site | string | веб-сайт | |
skype | string | skype-контакт | |
string | |||
vk | string | вконтакте | |
icq | string | номер-icq | |
birthdate | DateTime | дата рождения | |
lang | string | язык: Ru, En | |
canBeWorker | boolean | отображается в списке участников задачи | |
canBeClient | boolean | отображается в списке контрагентов задачи | |
group.id | int | идентификатор группы контактов | допустимые значения можно получить функцией contact.getGroupList |
customData | значения пользовательских полей контакта | ||
customData.customValue.id | идентификатор пользовательского поля контакта | ||
customData.customValue.value | значение пользовательского поля контакта | (для полей типа набор задач, список сотрудников, набор записей справочника - идентификаторы через запятую в квадратных скобках) | |
responsible | корневой элемент списка ответственных | ||
responsible .users | корневой элемент списка ответственных пользователей | ||
responsible .users.id | int | идентификатор пользователя | |
responsible .groups | корневой элемент списка групп ответственных | ||
responsible .groups.id | int | идентификатор группы | |
signature | string(32) | подпись |
Результат успешного выполнения функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<contact>
<id></id>
<general></general>
</contact>
<actionid></actionid>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
contact.id | int | идентификатор обновляемого контакта | |
contact.general | int | номер добавленного контакта | |
actionid | int | идентификатор действия об изменении |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>