Добавление

Добавление нового контрагента

POST https://do.freshoffice.ru/company/insert

Request Body

Name Type Description
company* JSON 
{
  "status": "success",
  "error": null,
  "code": "0",
  "rows": 1,
  "pages": 1,
  "page": 1,
  "value": "1"
}

JSON

Все доступные параметры нового объекта
  • name - * Наименование компании
  • first_name - Имя физического лица
  • last_name - Фамилия физического лица
  • middle_name - Отчество физического лица
  • person - Признак юридическое или физическое лицо [Int] (1/2)
  • address - Основной адрес
  • country - Страна
  • region - Регион
  • user_id - * Код ответственного
  • type_id - * Код типа
  • status_id - Код статуса
  • category_id - Код категории
  • url - Вэб сайт
  • activity_type - Род деятельности
  • info_source - Источник информации
  • note - Примечание
  • which_site_source - Web сайт источник лида
  • which_host_source - Web хост источник лида
  • which_link_source - Web ссылка перехода источник лида
  • utm_campaign - UTM источник лида
  • utm_source - UTM источник лида
  • utm_medium - UTM источник лида
  • utm_content - UTM источник лида
  • utm_term - UTM источник лида

Contacts - Список контактных лиц

  • first_name - Имя
  • last_name - Фамилия
  • position - Должность
  • note - Примечание
  • status_id - Код статуса контактного лица
  • Email - Список emal адресов контактного лица
  • Phones - Список телефонов контактного лица

Emails - Список email адресов контрагента

  • email - Email

Phones - Список телефонов контрагента

  • phone - Телефон
  • descr - Тип телефона

{
    "name" : "Apple",
    "type_id" : 1,
    "user_id" : 37,

    "Contacts": [
                 {
                  "first_name": "John",
                  "last_name": "Smith",
                  "position": "CEO",
                  "note": "The main decision maker",
                  "status_id": 1,
                  "Emails": [
                              {
                               "email": "John@example.com"
                              }
                            ],
                  "Phones": [
                              {
                               "phone": "+1 234 567890",
                               "descr": "mobile"
                              }
                            ]
                   }
                 ],
        "Emails": [
                     {
                       "email": "company@example.com"
                     }
                  ],
        "Phones": [
                     {
                       "phone": "+1 123 345678",
                        "descr": "Reception"
                      }
                   ]
  }

Примечание

Обязательные параметры
name (Наименование)
type_id (Код типа контрагента, можно взять в справчнике)
user_id (Код отвесвенного, можно взять пользователях)

Пример

curl --location --request POST 'https://do.freshoffice.ru/company/insert' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name" : "Apple",
    "type_id" : 1,
    "user_id" : 37,

    "Contacts": [
                 {
                  "first_name": "John",
                  "last_name": "Smith",
                  "position": "CEO",
                  "note": "The main decision maker",
                  "status_id": 1,
                  "Emails": [
                              {
                               "email": "John@example.com"
                              }
                            ],
                  "Phones": [
                              {
                               "phone": "+1 234 567890",
                               "descr": "mobile"
                              }
                            ]
                   }
                 ],
        "Emails": [
                     {
                       "email": "company@example.com"
                     }
                  ],
        "Phones": [
                     {
                       "phone": "+1 123 345678",
                        "descr": "Reception"
                      }
                   ]
  }
  '

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://do.freshoffice.ru/company/insert',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "name" : "Apple",
    "type_id" : 1,
    "user_id" : 37,

    "Contacts": [
                 {
                  "first_name": "John",
                  "last_name": "Smith",
                  "position": "CEO",
                  "note": "The main decision maker",
                  "status_id": 1,
                  "Emails": [
                              {
                               "email": "John@example.com"
                              }
                            ],
                  "Phones": [
                              {
                               "phone": "+1 234 567890",
                               "descr": "mobile"
                              }
                            ]
                   }
                 ],
        "Emails": [
                     {
                       "email": "company@example.com"
                     }
                  ],
        "Phones": [
                     {
                       "phone": "+1 123 345678",
                        "descr": "Reception"
                      }
                   ]
  }
  ',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer XXXXX-XXXXXXX-XXXXXXXXX',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://do.freshoffice.ru/company/insert',
  'headers': {
    'Authorization': 'Bearer XXXX-XXXXXXX-XXXXXXX',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "Apple",
    "type_id": 1,
    "user_id": 37,
    "Contacts": [
      {
        "first_name": "John",
        "last_name": "Smith",
        "position": "CEO",
        "note": "The main decision maker",
        "status_id": 1,
        "Emails": [
          {
            "email": "John@example.com"
          }
        ],
        "Phones": [
          {
            "phone": "+1 234 567890",
            "descr": "mobile"
          }
        ]
      }
    ],
    "Emails": [
      {
        "email": "company@example.com"
      }
    ],
    "Phones": [
      {
        "phone": "+1 123 345678",
        "descr": "Reception"
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Справочники

Для контрагентов

Пользователи

Ответ

{
  "status": "success",
  "error": null,
  "code": "0",
  "rows": 1,
  "pages": 1,
  "page": 1,
  "value": "1"
}
// value - ID идентификатор нового контрагента
Предыдущая
Список
Следующая
Обновление