• Post category:Контакты
  • Запись изменена:03.11.2022

POST api/2.0/crm/contact/company

Для этой функции требуется аутентификация. 

Описание
Создает компанию с параметрами, указанными в запросе.

Параметры

Название Описание Тип Пример
companyName

sent in body
Название компании строковый текст
about

sent in body
Текст описания компании

необязательно
строковый текст
personList

sent in body
Список пользователей связанных с компанией

необязательно
Коллекция чисел

Коллекция

1234
shareType

sent in body
Конфиденциальность компании: 0 — не предоставляется, 1 — предоставляется для чтения / записи, 2 — предоставляется только для чтения

 

None, ReadWrite, Read
managerList

sent in body
Список менеджеров компании

необязательно
Коллекция guids

Коллекция
9924256A-739C-462b-AF15-E652A3B1B6EB
customFieldList

sent in body
Список Custom field

необязательно
Collection of ASC.Api.Collections.ItemKeyValuePair`2[System.Int32,System.String]s

collection
photo

sent in body
Фото контакта (загрузить с использованием multipart/form-data)

необязательно
Файлы для добавления используют multipart/form-data

collection
N/A
Пример
POST api/2.0/crm/contact/company
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

{
  "companyName": "some text",
  "about": "some text",
  "personList": [
    1234
  ],
  "shareType": "none",
  "managerList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "customFieldList": [
    {
      "Key": 0,
      "Value": null
    }
  ],
  "photo": []
}
Возвращает
компанию
Пример ответа

application/json

{
  "status": 0,
  "response": {
    "companyName": "Food and Culture Project",
    "about": "",
    "haveLateTasks": false,
    "displayName": null,
    "isCompany": true,
    "isPrivate": true,
    "isShared": false,
    "shareType": 0,
    "currency": null,
    "canEdit": false,
    "canDelete": false,
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <companyName>Food and Culture Project</companyName>
    <about></about>
    <haveLateTasks>false</haveLateTasks>
    <displayName />
    <isCompany>true</isCompany>
    <isPrivate>true</isPrivate>
    <isShared>false</isShared>
    <shareType>0</shareType>
    <currency />
    <canEdit>false</canEdit>
    <canDelete>false</canDelete>
    <id>0</id>
  </response>
</result>