Добавление

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

POST https://do.myfreshcloud.com/company/insert

Request Body

Name	Type	Description
company*	JSON

200: OK Стандартный объект ответа

{
  "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 - Фамилия

• post - Должность

• 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",
                  "post": "CEO",
                  "note": "The main decision maker",
                  "status_id": 1,
                  "Emails": [
                              {
                               "email": "[email protected]"
                              }
                            ],
                  "Phones": [
                              {
                               "phone": "[phone]",
                               "descr": "mobile"
                              }
                            ]
                   } 
                 ],
        "Emails": [
                     {
                       "email": "[email protected]"
                     }
                  ],
        "Phones": [
                     {
                       "phone": "[phone]",
                        "descr": "Reception"
                      }
                   ]
  }
  
 

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

Пример

cURL

curl --location --request POST 'https://do.myfreshcloud.com/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",
                  "post": "CEO",
                  "note": "The main decision maker",
                  "status_id": 1,
                  "Emails": [
                              {
                               "email": "[email protected]"
                              }
                            ],
                  "Phones": [
                              {
                               "phone": "[phone]",
                               "descr": "mobile"
                              }
                            ]
                   } 
                 ],
        "Emails": [
                     {
                       "email": "[email protected]"
                     }
                  ],
        "Phones": [
                     {
                       "phone": "[phone]",
                        "descr": "Reception"
                      }
                   ]
  }
  '

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://do.myfreshcloud.com/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",
                  "post": "CEO",
                  "note": "The main decision maker",
                  "status_id": 1,
                  "Emails": [
                              {
                               "email": "[email protected]"
                              }
                            ],
                  "Phones": [
                              {
                               "phone": "[phone]",
                               "descr": "mobile"
                              }
                            ]
                   } 
                 ],
        "Emails": [
                     {
                       "email": "[email protected]"
                     }
                  ],
        "Phones": [
                     {
                       "phone": "[phone]",
                        "descr": "Reception"
                      }
                   ]
  }
  ',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer XXXXX-XXXXXXX-XXXXXXXXX',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS (Request)

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://do.myfreshcloud.com/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",
        "post": "CEO",
        "note": "The main decision maker",
        "status_id": 1,
        "Emails": [
          {
            "email": "[email protected]"
          }
        ],
        "Phones": [
          {
            "phone": "[phone]",
            "descr": "mobile"
          }
        ]
      }
    ],
    "Emails": [
      {
        "email": "[email protected]"
      }
    ],
    "Phones": [
      {
        "phone": "[phone]",
        "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 идентификатор нового контрагента