amocrm-rails 0.0.1 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4df871fabd8ad91146e392e6b74c27f56e5d017237c4980f864c4268e5fa585b
4
- data.tar.gz: 337a1b12acdf729258c5bce52670d4979bd0d06bec1e5816067d2227c45045be
3
+ metadata.gz: e3bc05a6130ce9c1517987f919c9cea7899763b658113095523a8666bd6347a9
4
+ data.tar.gz: f1233ee73dfc1d46bc6d29ebb86bd5626c2be6d5bf7119a617dacc78fc4e099c
5
5
  SHA512:
6
- metadata.gz: 23f529cfb57c206e34ea6849deff71381e960cbe97e552505be6b8d19c20d0974e5a9af221bd3887eeff54527bbe5058ede90bba342c26c76f85503d3424c4d1
7
- data.tar.gz: 2d79a29fbe36e4e3c5fc464ead8f892edefe0fe66720be4a8818da666ee574f32e36a9a50428e5b94b357f631ce111ee328b69e90bb4fc8cf1f9577cd7b8f273
6
+ metadata.gz: bd796c99c3f4a4931693a6065c0127aab66335547b14c8632bd9c6e5ba7237b155e07f0c77fdd820d2039f500d4d319aa86e11b79027b33a4172355d677d663f
7
+ data.tar.gz: 9b179d31d65a7c4ff53edfcbf4a610151698b39e0759caa9251c2a4671eb1f2925993996071cd0f805cd875c66eda3ee00f30c9f5d10f8aad8585d49754e1fa0
data/README.markdown CHANGED
@@ -1,6 +1,164 @@
1
1
  # Amocrm для Rails
2
2
 
3
- ## Установка
3
+ ## Оглавление
4
+ 0. [Установка](#install)
5
+ 1. [Параметры аккаунта](#account)
6
+ 2. [Сделки](#leads)
7
+ 1. [Список сделок](#leads_retrieve)
8
+ 2. [Получение сделки по ID](#lead_id_retrieve)
9
+ 3. [Добавление сделок](#leads_create)
10
+ 4. [Комплексное добавление сделок с контактом и компанией](#leads_complex)
11
+ 5. [Редактирование сделок](#leads_update)
12
+ 6. [Редактирование сделки](#lead_update)
13
+ 3. [Неразобранное](#unsorted)
14
+ 1. [Список неразобранного](#unsorted_retrieve)
15
+ 2. [Получение неразобранного по UID](#unsorted_uid_retrieve)
16
+ 3. [Добавление неразобранного типа звонок](#unsorted_uid_sip)
17
+ 4. [Добавление неразобранного типа форма](#unsorted_uid_forms)
18
+ 5. [Принятие неразобранного](#unsorted_uid_accept)
19
+ 6. [Отклонение неразобранного](#unsorted_uid_decline)
20
+ 7. [Привязка неразобранного](#unsorted_uid_link)
21
+ 8. [Сводная информация о неразобранных сделках](#unsorted_summary)
22
+ 9. [Описание объектов metadata](#unsorted_meta)
23
+ 4. [Воронки и этапы](#leads_pipelines)
24
+ 1. [Общая информация](#leads_pipelines_info)
25
+ 2. [Список воронок сделок](#leads_pipelines_list)
26
+ 3. [Получение воронки сделок по ID](#leads_pipelines_detail)
27
+ 4. [Добавление воронок](#leads_pipelines_add)
28
+ 5. [Редактирование воронки](#leads_pipelines_edit)
29
+ 6. [Удаление воронки](#leads_pipelines_delete)
30
+ 7. [Список статусов воронки сделок](#leads_pipelines_statuses_list)
31
+ 8. [Получение статуса воронки сделок по ID](#leads_pipelines_statuses_detail)
32
+ 9. [Добавление статусов в воронку](#leads_pipelines_statuses_add)
33
+ 10. [Редактирование статуса воронки](#leads_pipelines_statuses_edit)
34
+ 11. [Удаление статуса воронки](#leads_pipelines_statuses_delete)
35
+ 12. [Доступные цвета статусов](#leads_pipelines_statuses_colors)
36
+ 5. [Фильтрация](#filters)
37
+ 1. [Фильтрация списка сделок](#filters_leads)
38
+ 2. [Фильтрация списка контактов](#filters_contacts)
39
+ 3. [Фильтрация списка компаний](#filters_companies)
40
+ 4. [Фильтрация списка покупателей](#filters_customers)
41
+ 5. [Типы фильтров](#filters_types)
42
+ 6. [Контакты](#contacts)
43
+ 1. [Список контактов](#contacts_list)
44
+ 2. [Получение контакта по ID](#contacts_detail)
45
+ 3. [Добавление контактов](#contacts_add)
46
+ 4. [Редактирование контактов](#contacts_edit)
47
+ 5. [Редактирование контакта](#contact_edit)
48
+ 6. [Привязка чатов к контактам](#contacts_chat_connect)
49
+ 7. [Получение списка чатов контакта](#contacts_chat_list)
50
+ 7. [Компании](#companies)
51
+ 1. [Список компаний](#companies_list)
52
+ 2. [Получение компании по ID](#companies_detail)
53
+ 3. [Добавление компаний](#companies_add)
54
+ 4. [Редактирование компаний](#companies_edit)
55
+ 5. [Редактирование компании](#company_edit)
56
+ 8. [Списки](#catalogs)
57
+ 1. [Доступные списки](#catalogs_list)
58
+ 2. [Получение списка по ID](#catalogs_detail)
59
+ 3. [Добавление списков](#catalogs_add)
60
+ 4. [Редактирование списков](#catalogs_edit)
61
+ 5. [Редактирование списка](#catalog_edit)
62
+ 6. [Доступные элементы списка](#catalog_elements_list)
63
+ 7. [Получение элемента списка по ID](#catalog_elements_list_detail)
64
+ 8. [Добавление элементов списков](#catalog_elements_add)
65
+ 9. [Редактирование элементов списков](#catalog_elements_edit)
66
+ 10. [Редактирование элемента списка](#catalog_element_edit)
67
+ 9. [Связи сущностей](#links)
68
+ 1. [Список связанных сущностей](#links_list)
69
+ 2. [Привязка сущностей](#links_link)
70
+ 3. [Отвязка сущностей](#links_link)
71
+ 4. [Массовый список связанных сущностей](#mass_links_list)
72
+ 5. [Массовая привязка сущностей](#mass_links_link)
73
+ 6. [Массовая отвязка сущностей](#mass_links_unlink)
74
+ 10. [Задачи](#tasks)
75
+ 1. [Список задач](#tasks_list)
76
+ 2. [Получение задачи по ID](#tasks_detail)
77
+ 3. [Добавление задач](#tasks_add)
78
+ 4. [Редактирование задач](#tasks_edit)
79
+ 5. [Редактирование задачи](#task_edit)
80
+ 6. [Выполнение задачи](#task_complete)
81
+ 11. [Поля и группы полей](#custom_fields)
82
+ 1. [Список полей сущности](#custom_fields_list)
83
+ 2. [Получение поля сущности по его ID](#custom_fields_detail)
84
+ 3. [Создание дополнительных полей сущности](#custom_fields_add)
85
+ 4. [Редактирование дополнительных полей сущности](#custom_fields_edit)
86
+ 5. [Удаление дополнительного поля](#custom_fields_delete)
87
+ 6. [Список групп полей сущности](#custom_fields_groups_list)
88
+ 7. [Получение группы полей сущности по ID группы](#custom_fields_groups_detail)
89
+ 8. [Создание групп полей](#custom_fields_groups_add)
90
+ 9. [Редактирование группы полей](#custom_fields_groups_edit)
91
+ 10. [Удаление группы дополнительных полей](#custom_fields_groups_delete)
92
+ 11. [Доступные типы полей](#custom_fields_types)
93
+ 12. [Примеры заполнения разных типов полей через API](#custom_fields_examples)
94
+ 12. [Теги](#tags)
95
+ 1. [Список полей сущности](#tags_list)
96
+ 2. [Добавление тегов для конкретного типа сущности](#tags_add)
97
+ 3. [Добавление тегов к сущности](#add_tags_to_entity)
98
+ 4. [Удаление тегов у сущности](#delete_tags_from_entity)
99
+ 13. [События и примечания](#events_and_notes)
100
+ 1. [Список событий](#events_list)
101
+ 2. [Значения для фильтра по значению до/после](#events_filter_params)
102
+ 3. [Типы событий](#events_types)
103
+ 4. [Общая информация о примечаниях](#notes_common_info)
104
+ 5. [Типы примечаний](#notes_types)
105
+ 6. [Список примечаний по типу сущности](#notes_list)
106
+ 7. [Список примечаний по конкретной сущности, по ID сущности](#notes_entity_list)
107
+ 8. [Получение примечания по ID](#note_detail)
108
+ 9. [Добавление примечаний](#notes_add)
109
+ 14. [Покупатели](#customers)
110
+ 1. [Включение покупателей и смена их режима](#customers_mode)
111
+ 2. [Список покупателей](#customers_list)
112
+ 3. [Получение покупателя по ID](#customers_detail)
113
+ 4. [Добавление покупателей](#customers_add)
114
+ 5. [Редактирование покупателей](#customers_edit)
115
+ 6. [Редактирование покупателя](#customer_edit)
116
+ 7. [Список транзакций](#transactions_list)
117
+ 8. [Получение транзакции по ID](#transactions_detail)
118
+ 9. [Добавление транзакций к покупателю](#transactions_add)
119
+ 10. [Удаление транзакции](#transaction_delete)
120
+ 11. [Списание/начисление бонусных баллов покупателю](#customer_bonus_points_update)
121
+ 15. [Статусы и сегменты покупателей](#customers_statuses)
122
+ 1. [Список статусов покупателей](#customers_statuses_list)
123
+ 2. [Получение статуса покупателей по ID](#customers_statuses_detail)
124
+ 3. [Добавление статусов в воронку](#customers_statuses_add)
125
+ 4. [Редактирование статуса покупателей](#customers_statuses_edit)
126
+ 5. [Удаление статуса покупателей](#customer_status_delete)
127
+ 6. [Список сегментов покупателей](#segments_list)
128
+ 7. [Получение сегмента покупателей по ID](#segments_detail)
129
+ 8. [Добавление сегмента покупателей](#segments_add)
130
+ 9. [Редактирование сегмента покупателей](#segments_edit)
131
+ 10. [Удаление сегмента покупателей](#segment_delete)
132
+ 11. [Доступные цвета статусов](#customers_statuses_colors)
133
+ 12. [Доступные цвета сегментов](#customers_statuses_colors)
134
+ 16. [Пользователи](#users)
135
+ 1. [Список пользователей](#users_list)
136
+ 2. [Получение пользователя по ID](#users_detail)
137
+ 3. [Добавление пользователей](#users_add)
138
+ 4. [Список ролей пользователей](#roles_list)
139
+ 5. [Получение роли по ID](#roles_detail)
140
+ 6. [Добавление ролей](#roles_add)
141
+ 7. [Редактирование роли](#roles_edit)
142
+ 8. [Удаление роли](#roles_delete)
143
+ 9. [Общие обозначения прав пользователей](#users_common_rights)
144
+ 10. [Зависимости прав пользователей](#users_rights_dependence)
145
+ 17. [Товары](#products)
146
+ 18. [Вебхуки](#webhooks)
147
+ 1. [Список установленных вебхуков в аккаунте](#webhooks_list)
148
+ 2. [Подписка на вебхук](#webhooks_subscribe)
149
+ 3. [Отписка от событий](#webhooks_delete)
150
+ 4. [Возможные событий](#webhooks_available_actions)
151
+ 19. [Виджеты](#widgets)
152
+ 1. [Список виджетов](#widgets_list)
153
+ 2. [Информация о виджете по его коду](#widgets_detail)
154
+ 3. [Установка виджета в аккаунт](#widgets_install)
155
+ 4. [Удаление установки виджета](#widgets_uninstall)
156
+ 5. [Подтверждение выполнения блока виджета в Salesbot](#widgets_continue)
157
+ 20. [Добавление звонков](#calls)
158
+ 21. [Salebot](#salesbot)
159
+ 22. [Короткие ссылки](#short_links)
160
+
161
+ ## <a name="install"></a> Установка
4
162
 
5
163
  добавьте в Gemfile:
6
164
 
@@ -15,16 +173,1751 @@
15
173
  Вы можете изменять `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
16
174
 
17
175
  ```ruby
18
- AmocrmRals::Request.timeout = 15
19
- AmocrmRals::Request.open_timeout = 15
20
- AmocrmRals::Request.symbolize_keys = true
21
- AmocrmRals::Request.debug = false
176
+ AmocrmRails::Request.timeout = 60
177
+ AmocrmRails::Request.open_timeout = 60
178
+ AmocrmRails::Request.symbolize_keys = true
179
+ AmocrmRails::Request.debug = false
22
180
  ```
23
181
  в файле `config/initializers/amocrm.rb`
24
182
 
25
- ### СПИСКИ
26
- #### Перечень списков
183
+ ## <a name="account"></a> [Параметры аккаунта](https://www.amocrm.ru/developers/content/crm_platform/account-info)
184
+ ```ruby
185
+ params = {
186
+ with: 'amojo_id,amojo_rights,users_groups,task_types,version,entity_names,datetime_settings'
187
+ }
188
+ response = AmocrmRails::Request.account.retrieve(params: params)
189
+ p(response.body)
190
+ ```
191
+
192
+ ## <a name="leads"></a> Сделки
193
+ ### <a name="leads_retrieve"></a> [Список сделок](https://www.amocrm.ru/developers/content/crm_platform/leads-api)
194
+
195
+ ```ruby
196
+ params = {
197
+ with: 'catalog_elements',
198
+ page: 0,
199
+ limit: 10
200
+ }
201
+ response = AmocrmRails::Request.leads.retrieve(params: params)
202
+ p(response.body)
203
+ leads = response.body[:_embedded][:leads]
204
+ lead_id = leads.first[:id]
205
+ ```
206
+ ### <a name="lead_id_retrieve"></a> [Получение сделки по ID](https://www.amocrm.ru/developers/content/crm_platform/leads-api#lead-detail)
207
+
208
+ ```ruby
209
+ params = {
210
+ with: 'catalog_elements'
211
+ }
212
+ response = AmocrmRails::Request.leads(lead_id).retrieve(params: params)
213
+ p(response.body)
214
+ ```
215
+ ### <a name="leads_create"></a> [Добавление сделок](https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-add)
216
+
217
+ ```ruby
218
+ body = [
219
+ {
220
+ "name": "Сделка для примера 1",
221
+ "created_by": 0,
222
+ "price": 20000
223
+ },
224
+ {
225
+ "name": "Сделка для примера 2",
226
+ "price": 10000
227
+ }
228
+ ]
229
+ response = AmocrmRails::Request.leads.create(body: body)
230
+ p(response.body)
231
+ leads = response.body[:_embedded][:leads]
232
+ ```
233
+ ### <a name="leads_complex"></a> [Комплексное добавление сделок с контактом и компанией](https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-complex-add)
234
+
235
+ ```ruby
236
+ body = [
237
+ {
238
+ name: "Название сделки",
239
+ price: 3422,
240
+ created_at: 1608905348
241
+ },
242
+ {
243
+ name: "Название сделки",
244
+ price: 3422
245
+ }
246
+ ]
247
+ response = AmocrmRails::Request.leads.complex.create(body: body)
248
+ p(response.body)
249
+ ```
250
+ ### <a name="leads_update"></a> [Редактирование сделок](https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-edit)
251
+ ```ruby
252
+ body = [
253
+ {
254
+ id: 666749,
255
+ closed_at: 1589297221
256
+ },
257
+ {
258
+ id: 666753,
259
+ price: 50000
260
+ }
261
+ ]
262
+ response = AmocrmRails::Request.leads.update(body: body)
263
+ p(response.body)
264
+ leads = response.body[:_embedded][:leads]
265
+ ```
266
+ ### <a name="lead_update"></a> [Редактирование сделки](https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-edit)
267
+
268
+ ```ruby
269
+ body = {
270
+ closed_at: 1589297221
271
+ }
272
+ response = AmocrmRails::Request.leads(666749).update(body: body)
273
+ p(response.body)
274
+ leads = response.body[:_embedded][:leads]
275
+ ```
276
+
277
+ ## <a name="unsorted"></a> Неразобранное
278
+ ### <a name="unsorted_retrieve"></a> [Список неразобранного](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-list)
279
+
280
+ ```ruby
281
+ params = {
282
+ page: 0,
283
+ limit: 10
284
+ }
285
+ response = AmocrmRails::Request.leads.unsorted.retrieve(params: params)
286
+ p(response.body)
287
+ unsorted = response.body[:_embedded][:unsorted]
288
+ uid = unsorted.first[:uid]
289
+ ```
290
+ ### <a name="unsorted_uid_retrieve"></a> [Получение неразобранного по UID](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-detail)
291
+
292
+ ```ruby
293
+ response = AmocrmRails::Request.leads.unsorted(uid).retrieve
294
+ p(response.body)
295
+ ```
296
+ ### <a name="unsorted_uid_sip"></a> [Добавление неразобранного типа звонок](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-add-sip)
297
+
298
+ ```ruby
299
+ body = [
300
+ {
301
+ source_name: "ОАО Коспромсервис",
302
+ source_uid: "a1fee7c0fc436088e64ba2e8822ba2b3",
303
+ created_at: 1510261200,
304
+ _embedded: {
305
+ leads: [
306
+ {
307
+ name: "Тех обслуживание",
308
+ price: 5000
309
+ }
310
+ ],
311
+ contacts: [
312
+ {
313
+ name: "Контакт для примера"
314
+ }
315
+ ],
316
+ companies: [
317
+ {
318
+ name: "ОАО Коспромсервис"
319
+ }
320
+ ]
321
+ },
322
+ metadata: {
323
+ is_call_event_needed: true,
324
+ uniq: "a1fe231cc88e64ba2e8822ba2b3ewrw",
325
+ duration: 54,
326
+ service_code: "CkAvbEwPam6sad",
327
+ link: "https://example.com",
328
+ phone: 79998888888,
329
+ called_at: 1510261200,
330
+ from: "onlinePBX"
331
+ }
332
+ }
333
+ ]
334
+ response = AmocrmRails::Request.leads.unsorted.sip.create(body: body)
335
+ p(response.body)
336
+ ```
337
+ ### <a name="unsorted_uid_forms"></a> [Добавление неразобранного типа форма](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-add-form)
338
+
339
+ ```ruby
340
+ body = [
341
+ {
342
+ source_name: "ОАО Коспромсервис",
343
+ source_uid: "a1fee7c0fc436088e64ba2e8822ba2b3",
344
+ created_at: 1590830520,
345
+ _embedded: {
346
+ leads: [
347
+ {
348
+ name: "Тех обслуживание",
349
+ visitor_uid: "5692210d-58d0-468c-acb2-dce7f93eef87",
350
+ price: 5000,
351
+ _embedded: {
352
+ tags: [
353
+ {
354
+ name: "Тег для примера"
355
+ }
356
+ ]
357
+ }
358
+ }
359
+ ],
360
+ contacts: [
361
+ {
362
+ name: 234,
363
+ first_name: "123213",
364
+ last_name: 234,
365
+ custom_fields_values: [
366
+ {
367
+ field_code: "PHONE",
368
+ values: [
369
+ {
370
+ value: "+7912321323"
371
+ }
372
+ ]
373
+ }
374
+ ]
375
+ }
376
+ ],
377
+ companies: [
378
+ {
379
+ name: "ОАО Коспромсервис"
380
+ }
381
+ ]
382
+ },
383
+ metadata: {
384
+ ip: "123.222.2.22",
385
+ form_id: "a1fee7c0fc436088e64ba2e8822ba2b3ewrw",
386
+ form_sent_at: 1590830520,
387
+ form_name: "Форма заявки для полёта в космос",
388
+ form_page: "https://example.com",
389
+ referer: "https://www.google.com/search?&q=elon+musk"
390
+ }
391
+ }
392
+ ]
393
+ response = AmocrmRails::Request.leads.unsorted.forms.create(body: body)
394
+ p(response.body)
395
+ uid = response.body[:_embedded][:unsorted].first[:uid]
396
+ ```
397
+ ### <a name="unsorted_uid_accept"></a> [Принятие неразобранного](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-accept)
398
+
399
+ ```ruby
400
+ body = {
401
+ status_id: 41504311
402
+ }
403
+ response = AmocrmRails::Request.leads.unsorted(uid).accept.create(body: body)
404
+ p(response.body)
405
+ ```
406
+ ### <a name="unsorted_uid_decline"></a> [Отклонение неразобранного](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-decline)
407
+
408
+ ```ruby
409
+ response = AmocrmRails::Request.leads.unsorted(uid).decline.delete
410
+ p(response.body)
411
+ ```
412
+ ### <a name="unsorted_uid_link"></a> [Привязка неразобранного](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-link)
413
+
414
+ ```ruby
415
+ body = {
416
+ link: {
417
+ entity_id: lead_id,
418
+ entity_type: "leads"
419
+ }
420
+ }
421
+ response = AmocrmRails::Request.leads.unsorted(uid).link.create(body: body)
422
+ p(response.body)
423
+ ```
424
+ ### <a name="unsorted_summary"></a> [Сводная информация о неразобранных сделках](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-summary)
425
+
426
+ ```ruby
427
+ response = AmocrmRails::Request.leads.unsorted.summary.retrieve
428
+ p(response.body)
429
+ ```
430
+ ### <a name="unsorted_meta"></a> [Описание объектов metadata](https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#metadata-description)
431
+
432
+ ## <a name="leads_pipelines"></a> Воронки и этапы
433
+
434
+ ### <a name="leads_pipelines_info"></a> [Общая информация](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#common-info)
435
+ ### <a name="leads_pipelines_list"></a> [Список воронок сделок](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#pipelines-list)
436
+ ```ruby
437
+ response = AmocrmRails::Request.leads.pipelines.retrieve
438
+ p(response.body)
439
+ pipelines = response.body[:_embedded][:pipelines]
440
+ pipeline_id = pipelines.first[:id]
441
+ ```
442
+ ### <a name="leads_pipelines_detail"></a> [Получение воронки сделок по ID](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#pipeline-detail)
443
+ ```ruby
444
+ response = AmocrmRails::Request.leads.pipelines(pipeline_id).retrieve
445
+ p(response.body)
446
+ ```
447
+ ### <a name="leads_pipelines_add"></a> [Добавление воронок](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#pipelines-add)
448
+ ```ruby
449
+ body = [
450
+ {
451
+ name: "Воронка доп продаж",
452
+ is_main: false,
453
+ is_unsorted_on: true,
454
+ sort: 20,
455
+ request_id: "123",
456
+ _embedded: {
457
+ statuses: [
458
+ {
459
+ id: 142,
460
+ name: "Мое название для успешных сделок"
461
+ },
462
+ {
463
+ name: "Первичный контакт",
464
+ sort: 10,
465
+ color: "#fffeb2"
466
+ }
467
+ ]
468
+ }
469
+ }
470
+ ]
471
+ response = AmocrmRails::Request.leads.pipelines.create(body: body)
472
+ p(response.body)
473
+ pipelines = response.body[:_embedded][:pipelines]
474
+ pipeline_id = pipelines.first[:id]
475
+ ```
476
+ ### <a name="leads_pipelines_edit"></a> [Редактирование воронки](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#pipeline-edit)
477
+ ```ruby
478
+ body = {
479
+ "name": "Новое название для воронки",
480
+ "is_main": false,
481
+ "is_unsorted_on": false,
482
+ "sort": 100
483
+ }
484
+ response = AmocrmRails::Request.leads.pipelines(pipeline_id).update(body: body)
485
+ p(response.body)
486
+ ```
487
+ ### <a name="leads_pipelines_delete"></a> [Удаление воронки](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#pipeline-delete)
488
+ ```ruby
489
+ AmocrmRails::Request.leads.pipelines(pipeline_id).delete
490
+ ```
491
+ ### <a name="leads_pipelines_statuses_list"></a> [Список статусов воронки сделок](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#statuses-list)
492
+ ```ruby
493
+ response = AmocrmRails::Request.leads.pipelines(pipeline_id).statuses.retrieve
494
+ p(response.body)
495
+ statuses = response.body[:_embedded][:statuses]
496
+ status_id = statuses.first[:id]
497
+ ```
498
+ ### <a name="leads_pipelines_statuses_detail"></a> [Получение статуса воронки сделок по ID](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#status-detail)
499
+ ```ruby
500
+ response = AmocrmRails::Request.leads.pipelines(pipeline_id).statuses(status_id).retrieve
501
+ p(response.body)
502
+ ```
503
+ ### <a name="leads_pipelines_statuses_add"></a> [Добавление статусов в воронку](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#statuses-add)
504
+ ```ruby
505
+ body = [
506
+ {
507
+ name: "Новый этап",
508
+ sort: 100,
509
+ color: "#fffeb2"
510
+ },
511
+ {
512
+ name: "Новый этап 2",
513
+ sort: 200,
514
+ color: "#fffeb2"
515
+ }
516
+ ]
517
+ response = AmocrmRails::Request.leads.pipelines(pipeline_id).statuses.create(body: body)
518
+ p(response.body)
519
+ statuses = response.body[:_embedded][:statuses]
520
+ status_id = statuses.first[:id]
521
+ ```
522
+ ### <a name="leads_pipelines_statuses_edit"></a> [Редактирование статуса воронки](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#status-edit)
523
+ ```ruby
524
+ body = {
525
+ name: "Новое название для статуса",
526
+ color: "#c1e0ff"
527
+ }
528
+ response = AmocrmRails::Request.leads.pipelines(pipeline_id).statuses(status_id).update(body: body)
529
+ p(response.body)
530
+ ```
531
+ ### <a name="leads_pipelines_statuses_delete"></a> [Удаление статуса воронки](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#status-delete)
532
+ ```ruby
533
+ AmocrmRails::Request.leads.pipelines(pipeline_id).statuses(status_id).delete
534
+ ```
535
+ ### <a name="leads_pipelines_statuses_colors"></a> [Доступные цвета статусов](https://www.amocrm.ru/developers/content/crm_platform/leads_pipelines#statuses-colors)
536
+
537
+ ## <a name="filters"></a> [Фильтрация](https://www.amocrm.ru/developers/content/crm_platform/filters-api)
538
+ ### <a name="filters_leads"></a> [Фильтрация списка сделок](https://www.amocrm.ru/developers/content/crm_platform/filters-api#leads-filter)
539
+ ```ruby
540
+ params = {
541
+ filter: {
542
+ id: lead_id
543
+ }
544
+ }
545
+ response = AmocrmRails::Request.leads.retrieve(params: params)
546
+ p(response.body)
547
+ leads = response.body[:_embedded][:leads]
548
+ ```
549
+ ### <a name="filters_contacts"></a> [Фильтрация списка контактов](https://www.amocrm.ru/developers/content/crm_platform/filters-api#contacts-filter)
550
+ ```ruby
551
+ params = {
552
+ filter: {
553
+ name: "Павел Осетров"
554
+ }
555
+ }
556
+ response = AmocrmRails::Request.contacts.retrieve(params: params)
557
+ p(response.body)
558
+ contacts = response.body[:_embedded][:contacts]
559
+ ```
560
+ ### <a name="filters_companies"></a> [Фильтрация списка компаний](https://www.amocrm.ru/developers/content/crm_platform/filters-api#companies-filter)
561
+ ```ruby
562
+ params = {
563
+ filter: {
564
+ name: "ОАО Коспромсервис"
565
+ }
566
+ }
567
+ response = AmocrmRails::Request.companies.retrieve(params: params)
568
+ p(response.body)
569
+ companies = response.body[:_embedded][:companies]
570
+ ```
571
+ ### <a name="filters_customers"></a> [Фильтрация списка покупателей](https://www.amocrm.ru/developers/content/crm_platform/filters-api#customers-filter)
572
+ ```ruby
573
+ params = {
574
+ filter: {
575
+ name: "Павел Осетров"
576
+ }
577
+ }
578
+ response = AmocrmRails::Request.customers.retrieve(params: params)
579
+ p(response.body)
580
+ customers = response.body[:_embedded][:customers]
581
+ ```
582
+ ### <a name="filters_types"></a> [Типы фильтров](https://www.amocrm.ru/developers/content/crm_platform/filters-api#filter-types)
583
+
584
+ ## <a name="contacts"></a> [Контакты](https://www.amocrm.ru/developers/content/crm_platform/contacts-api)
585
+ ### <a name="contacts_list"></a> [Список контактов](https://www.amocrm.ru/developers/content/crm_platform/contacts-api#contacts-list)
586
+ ```ruby
587
+ params = {
588
+ with: 'leads',
589
+ page: 0,
590
+ limit: 10
591
+ }
592
+ response = AmocrmRails::Request.contacts.retrieve(params: params)
593
+ p(response.body)
594
+ contacts = response.body[:_embedded][:contacts]
595
+ contact_id = contacts.first[:id]
596
+ ```
597
+ ### <a name="contacts_detail"></a> [Получение контакта по ID](https://www.amocrm.ru/developers/content/crm_platform/contacts-api#contact-detail)
598
+ ```ruby
599
+ response = AmocrmRails::Request.contacts(contact_id).retrieve
600
+ p(response.body)
601
+ ```
602
+ ### <a name="contacts_add"></a> [Добавление контактов](https://www.amocrm.ru/developers/content/crm_platform/contacts-api#contacts-add)
603
+ ```ruby
604
+ body = [
605
+ {
606
+ first_name: "Петр",
607
+ last_name: "Смирнов"
608
+ },
609
+ {
610
+ name: "Владимир Смирнов"
611
+ }
612
+ ]
613
+ response = AmocrmRails::Request.contacts.create(body: body)
614
+ p(response.body)
615
+ contacts = response.body[:_embedded][:contacts]
616
+ contact_id = contacts.first[:id]
617
+ ```
618
+ ### <a name="contacts_edit"></a> [Редактирование контактов](https://www.amocrm.ru/developers/content/crm_platform/contacts-api#contacts-edit)
619
+ ```ruby
620
+ body = [
621
+ {
622
+ id: contact_id,
623
+ first_name: "Иван",
624
+ last_name: "Иванов"
625
+ }
626
+ ]
627
+ response = AmocrmRails::Request.contacts.update(body: body)
628
+ p(response.body)
629
+ contacts = response.body[:_embedded][:contacts]
630
+ contact_id = contacts.first[:id]
631
+ ```
632
+ ### <a name="contact_edit"></a> [Редактирование контакта](https://www.amocrm.ru/developers/content/crm_platform/contacts-api#contacts-edit)
633
+ ```ruby
634
+ body = {
635
+ first_name: "Иван",
636
+ last_name: "Иванов"
637
+ }
638
+ response = AmocrmRails::Request.contacts(contact_id).update(body: body)
639
+ p(response.body)
640
+ ```
641
+ ### <a name="contacts_chat_connect"></a> [Привязка чатов к контактам](https://www.amocrm.ru/developers/content/crm_platform/contacts-api#contacts-chat-connect)
642
+ ```ruby
643
+ body = [
644
+ {
645
+ contact_id: contact_id,
646
+ chat_id: uid
647
+ }
648
+ ]
649
+ response = AmocrmRails::Request.contacts.chats.create(body: body)
650
+ p(response.body)
651
+ ```
652
+ ### <a name="contacts_chat_list"></a> [Получение списка чатов контакта](https://www.amocrm.ru/developers/content/crm_platform/contacts-api#contacts-chat-list)
653
+ ```ruby
654
+ params = [
655
+ {
656
+ contact_id: contact_id
657
+ }
658
+ ]
659
+ response = AmocrmRails::Request.contacts.chats.retrieve(params: params)
660
+ p(response.body)
661
+ ```
662
+ ## <a name="companies"></a> [Компании](https://www.amocrm.ru/developers/content/crm_platform/companies-api)
663
+ ### <a name="companies_list"></a> [Список компаний](https://www.amocrm.ru/developers/content/crm_platform/companies-api#companies-list)
664
+ ```ruby
665
+ params = {
666
+ with: 'leads',
667
+ page: 0,
668
+ limit: 10
669
+ }
670
+ response = AmocrmRails::Request.companies.retrieve(params: params)
671
+ p(response.body)
672
+ companies = response.body[:_embedded][:companies]
673
+ company_id = companies.first[:id]
674
+ ```
675
+ ### <a name="companies_detail"></a> [Получение компании по ID](https://www.amocrm.ru/developers/content/crm_platform/companies-api#company-detail)
676
+ ```ruby
677
+ response = AmocrmRails::Request.companies(company_id).retrieve
678
+ p(response.body)
679
+ ```
680
+ ### <a name="companies_add"></a> [Добавление компаний](https://www.amocrm.ru/developers/content/crm_platform/companies-api#companies-add)
681
+ ```ruby
682
+ body = [
683
+ {
684
+ name: "ООО Деппа"
685
+ }
686
+ ]
687
+ response = AmocrmRails::Request.companies.create(body: body)
688
+ p(response.body)
689
+ companies = response.body[:_embedded][:companies]
690
+ company_id = companies.first[:id]
691
+ ```
692
+ ### <a name="companies_edit"></a> [Редактирование компаний](https://www.amocrm.ru/developers/content/crm_platform/companies-api#companies-edit)
693
+ ```ruby
694
+ body = [
695
+ {
696
+ id: company_id,
697
+ name: "ООО ДЕППА"
698
+ }
699
+ ]
700
+ response = AmocrmRails::Request.companies.update(body: body)
701
+ p(response.body)
702
+ companies = response.body[:_embedded][:companies]
703
+ company_id = companies.first[:id]
704
+ ```
705
+ ### <a name="company_edit"></a> [Редактирование компании](https://www.amocrm.ru/developers/content/crm_platform/companies-api#companies-edit)
706
+ ```ruby
707
+ body = {
708
+ name: "ООО ДЕППА"
709
+ }
710
+ response = AmocrmRails::Request.companies(company_id).update(body: body)
711
+ p(response.body)
712
+ company_id = response.body[:id]
713
+ ```
714
+ ## <a name="catalogs"></a> [Списки](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api)
715
+ ### <a name="catalogs_list"></a> [Доступные списки](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#lists-list)
716
+ ```ruby
717
+ params = {
718
+ page: 0,
719
+ limit: 10
720
+ }
721
+ response = AmocrmRails::Request.catalogs.retrieve(params: params)
722
+ p(response.body)
723
+ catalogs = response.body[:_embedded][:catalogs]
724
+ catalog_id = catalogs.first[:id]
725
+ ```
726
+ ### <a name="catalogs_detail"></a> [Получение списка по ID](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#list-detail)
727
+ ```ruby
728
+ response = AmocrmRails::Request.catalogs(catalog_id).retrieve
729
+ p(response.body)
730
+ ```
731
+ ### <a name="catalogs_add"></a> [Добавление списков](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#lists-add)
732
+ ```ruby
733
+ body = [
734
+ {
735
+ name: "Тестовый список",
736
+ can_add_elements: true,
737
+ can_link_multiple: false
738
+ }
739
+ ]
740
+ response = AmocrmRails::Request.catalogs.create(body: body)
741
+ p(response.body)
742
+ catalogs = response.body[:_embedded][:catalogs]
743
+ catalog_id = catalogs.first[:id]
744
+ ```
745
+ ### <a name="catalogs_edit"></a> [Редактирование списков](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#lists-edit)
746
+ ```ruby
747
+ body = [
748
+ {
749
+ id: catalog_id,
750
+ name: "Новое имя списка"
751
+ }
752
+ ]
753
+ response = AmocrmRails::Request.catalogs.update(body: body)
754
+ p(response.body)
755
+ catalogs = response.body[:_embedded][:catalogs]
756
+ catalog_id = catalogs.first[:id]
757
+ ```
758
+ ### <a name="catalog_edit"></a> [Редактирование списка](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#lists-edit)
759
+ ```ruby
760
+ body = {
761
+ name: "Новое имя списка"
762
+ }
763
+ response = AmocrmRails::Request.catalogs(catalog_id).update(body: body)
764
+ p(response.body)
765
+ catalog_id = response.body[:id]
766
+ ```
767
+ ### <a name="catalog_elements_list"></a> [Доступные элементы списка](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#list-elements-list)
768
+ ```ruby
769
+ params = {
770
+ with: 'invoice_link',
771
+ page: 0,
772
+ limit: 10
773
+ }
774
+ response = AmocrmRails::Request.catalogs(catalog_id).elements.retrieve(params: params)
775
+ p(response.body)
776
+ elements = response.body[:_embedded][:elements]
777
+ element_id = elements.first[:id]
778
+ ```
779
+ ### <a name="catalog_elements_list_detail"></a> [Получение элемента списка по ID](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#list-elements-detail)
780
+ ```ruby
781
+ params = {
782
+ with: 'invoice_link'
783
+ }
784
+ response = AmocrmRails::Request.catalogs(catalog_id).elements(element_id).retrieve(params: params)
785
+ p(response.body)
786
+ element_id = response.body[:id]
787
+ ```
788
+ ### <a name="catalog_elements_add"></a> [Добавление элементов списков](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#list-elements-add)
789
+ ```ruby
790
+ body = [
791
+ {
792
+ name: "Новый элемент списка"
793
+ }
794
+ ]
795
+ response = AmocrmRails::Request.catalogs(catalog_id).elements.create(body: body)
796
+ p(response.body)
797
+ elements = response.body[:_embedded][:elements]
798
+ element_id = elements.first[:id]
799
+ ```
800
+ ### <a name="catalog_elements_edit"></a> [Редактирование элементов списков](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#list-elements-edit)
801
+ ```ruby
802
+ body = [
803
+ {
804
+ id: element_id,
805
+ name: "Новое имя элемента"
806
+ }
807
+ ]
808
+ response = AmocrmRails::Request.catalogs(catalog_id).elements.update(body: body)
809
+ p(response.body)
810
+ elements = response.body[:_embedded][:elements]
811
+ element_id = elements.first[:id]
812
+ ```
813
+ ### <a name="catalog_element_edit"></a> [Редактирование элемента списка](https://www.amocrm.ru/developers/content/crm_platform/catalogs-api#list-elements-edit)
814
+ ```ruby
815
+ body = {
816
+ name: "Новое имя элемента"
817
+ }
818
+ response = AmocrmRails::Request.catalogs(catalog_id).elements(element_id).update(body: body)
819
+ p(response.body)
820
+ element_id = response.body[:id]
821
+ ```
822
+ ## <a name="links"></a> [Связи сущностей](https://www.amocrm.ru/developers/content/crm_platform/entity-links-api)
823
+ ### <a name="links_list"></a> [Список связанных сущностей](https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#links-list)
27
824
  ```ruby
28
- response = AmocrmRals::Request.catalogs.retrieve
29
- p(response.body)
30
- ```
825
+ response = AmocrmRails::Request.leads(lead_id).links.retrieve
826
+ links = response.body[:_embedded][:links]
827
+ ```
828
+ ```ruby
829
+ response = AmocrmRails::Request.contacts(contact_id).links.retrieve
830
+ links = response.body[:_embedded][:links]
831
+ ```
832
+ ```ruby
833
+ response = AmocrmRails::Request.companies(company_id).links.retrieve
834
+ links = response.body[:_embedded][:links]
835
+ ```
836
+ ```ruby
837
+ response = AmocrmRails::Request.customers(customer_id).links.retrieve
838
+ links = response.body[:_embedded][:links]
839
+ ```
840
+ ### <a name="links_link"></a> [Привязка сущностей](https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#links-link)
841
+ ```ruby
842
+ body = [
843
+ {
844
+ to_entity_id: 10,
845
+ to_entity_type: "catalog_elements",
846
+ metadata: {
847
+ quantity: 1,
848
+ catalog_id: 1026
849
+ }
850
+ },
851
+ {
852
+ to_entity_id: 457282,
853
+ to_entity_type: "contacts",
854
+ metadata: {
855
+ is_main: true,
856
+ }
857
+ }
858
+ ]
859
+ ```
860
+ ```ruby
861
+ response = AmocrmRails::Request.leads(lead_id).link.create(body: body)
862
+ links = response.body[:_embedded][:links]
863
+ ```
864
+ ```ruby
865
+ response = AmocrmRails::Request.contacts(contact_id).link.create(body: body)
866
+ links = response.body[:_embedded][:links]
867
+ ```
868
+ ```ruby
869
+ response = AmocrmRails::Request.companies(company_id).link.create(body: body)
870
+ links = response.body[:_embedded][:links]
871
+ ```
872
+ ```ruby
873
+ response = AmocrmRails::Request.customers(customer_id).link.create(body: body)
874
+ links = response.body[:_embedded][:links]
875
+ ```
876
+ ### <a name="links_unlink"></a> [Отвязка сущностей](https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#links-unlink)
877
+ ```ruby
878
+ body = [
879
+ {
880
+ to_entity_id: 10,
881
+ to_entity_type: "catalog_elements",
882
+ metadata: {
883
+ catalog_id: 1026
884
+ }
885
+ },
886
+ {
887
+ to_entity_id: 457282,
888
+ to_entity_type: "contacts",
889
+ }
890
+ ]
891
+ ```
892
+ ```ruby
893
+ response = AmocrmRails::Request.leads(lead_id).unlink.create(body: body)
894
+ links = response.body[:_embedded][:links]
895
+ ```
896
+ ```ruby
897
+ response = AmocrmRails::Request.contacts(contact_id).unlink.create(body: body)
898
+ links = response.body[:_embedded][:links]
899
+ ```
900
+ ```ruby
901
+ response = AmocrmRails::Request.companies(company_id).unlink.create(body: body)
902
+ links = response.body[:_embedded][:links]
903
+ ```
904
+ ```ruby
905
+ response = AmocrmRails::Request.customers(customer_id).unlink.create(body: body)
906
+ links = response.body[:_embedded][:links]
907
+ ```
908
+ ### <a name="mass_links_list"></a> [Массовый список связанных сущностей](https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#mass-links-list)
909
+ ```ruby
910
+ response = AmocrmRails::Request.leads.links.retrieve
911
+ links = response.body[:_embedded][:links]
912
+ ```
913
+ ```ruby
914
+ response = AmocrmRails::Request.contacts.links.retrieve
915
+ links = response.body[:_embedded][:links]
916
+ ```
917
+ ```ruby
918
+ response = AmocrmRails::Request.companies.links.retrieve
919
+ links = response.body[:_embedded][:links]
920
+ ```
921
+ ```ruby
922
+ response = AmocrmRails::Request.customers.links.retrieve
923
+ links = response.body[:_embedded][:links]
924
+ ```
925
+ ### <a name="mass_links_link"></a> [Массовая привязка сущностей](https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#mass-links-link)
926
+ ```ruby
927
+ body = [
928
+ {
929
+ entity_id: 14158851,
930
+ to_entity_id: 10,
931
+ to_entity_type: "catalog_elements",
932
+ metadata: {
933
+ quantity: 1,
934
+ catalog_id: 1026
935
+ }
936
+ },
937
+ {
938
+ entity_id: 14158852,
939
+ to_entity_id: 457282,
940
+ to_entity_type: "contacts",
941
+ metadata: {
942
+ is_main: true,
943
+ }
944
+ }
945
+ ]
946
+ ```
947
+ ```ruby
948
+ response = AmocrmRails::Request.leads.link.create(body: body)
949
+ links = response.body[:_embedded][:links]
950
+ ```
951
+ ```ruby
952
+ response = AmocrmRails::Request.contacts.link.create(body: body)
953
+ links = response.body[:_embedded][:links]
954
+ ```
955
+ ```ruby
956
+ response = AmocrmRails::Request.companies.link.create(body: body)
957
+ links = response.body[:_embedded][:links]
958
+ ```
959
+ ```ruby
960
+ response = AmocrmRails::Request.customers.link.create(body: body)
961
+ links = response.body[:_embedded][:links]
962
+ ```
963
+ ### <a name="mass_links_unlink"></a> [Массовая отвязка сущностей](https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#mass-links-unlink)
964
+ ```ruby
965
+ body = [
966
+ {
967
+ to_entity_id: 10,
968
+ to_entity_type: "catalog_elements",
969
+ metadata: {
970
+ catalog_id: 1026
971
+ }
972
+ },
973
+ {
974
+ to_entity_id: 457282,
975
+ to_entity_type: "contacts",
976
+ }
977
+ ]
978
+ ```
979
+ ```ruby
980
+ response = AmocrmRails::Request.leads.unlink.create(body: body)
981
+ links = response.body[:_embedded][:links]
982
+ ```
983
+ ```ruby
984
+ response = AmocrmRails::Request.contacts.unlink.create(body: body)
985
+ links = response.body[:_embedded][:links]
986
+ ```
987
+ ```ruby
988
+ response = AmocrmRails::Request.companies.unlink.create(body: body)
989
+ links = response.body[:_embedded][:links]
990
+ ```
991
+ ```ruby
992
+ response = AmocrmRails::Request.customers.unlink.create(body: body)
993
+ links = response.body[:_embedded][:links]
994
+ ```
995
+ ## <a name="tasks"></a> [Задачи](https://www.amocrm.ru/developers/content/crm_platform/tasks-api)
996
+ ### <a name="tasks_list"></a> [Список задач](https://www.amocrm.ru/developers/content/crm_platform/tasks-api#tasks-list)
997
+ ```ruby
998
+ params = {
999
+ page: 0,
1000
+ limit: 10
1001
+ }
1002
+ response = AmocrmRails::Request.tasks.retrieve(params: params)
1003
+ p(response.body)
1004
+ tasks = response.body[:_embedded][:tasks]
1005
+ task_id = tasks.first[:id]
1006
+ ```
1007
+ ### <a name="tasks_detail"></a> [Получение задачи по ID](https://www.amocrm.ru/developers/content/crm_platform/tasks-api#task-detail)
1008
+ ```ruby
1009
+ response = AmocrmRails::Request.tasks(task_id).retrieve
1010
+ p(response.body)
1011
+ task_id = response.body[:id]
1012
+ ```
1013
+ ### <a name="tasks_add"></a> [Добавление задач](https://www.amocrm.ru/developers/content/crm_platform/tasks-api#tasks-add)
1014
+ ```ruby
1015
+ body = [
1016
+ {
1017
+ task_type_id: 1,
1018
+ text: "Встретиться с клиентом Иван Иванов",
1019
+ complete_till: 1588885140
1020
+ }
1021
+ ]
1022
+ response = AmocrmRails::Request.tasks.create(body: body)
1023
+ p(response.body)
1024
+ tasks = response.body[:_embedded][:tasks]
1025
+ ```
1026
+ ### <a name="tasks_edit"></a> [Редактирование задач](https://www.amocrm.ru/developers/content/crm_platform/tasks-api#tasks-edit)
1027
+ ```ruby
1028
+ body = [
1029
+ {
1030
+ id: task_id,
1031
+ task_type_id: 2,
1032
+ text: "Новое название для задачи",
1033
+ complete_till: 1588885140
1034
+ }
1035
+ ]
1036
+ response = AmocrmRails::Request.tasks.update(body: body)
1037
+ p(response.body)
1038
+ tasks = response.body[:_embedded][:tasks]
1039
+ ```
1040
+ ### <a name="task_edit"></a> [Редактирование задачи](https://www.amocrm.ru/developers/content/crm_platform/tasks-api#tasks-edit)
1041
+ ```ruby
1042
+ body = {
1043
+ task_type_id: 2,
1044
+ text: "Новое название для задачи",
1045
+ complete_till: 1588885140
1046
+ }
1047
+ response = AmocrmRails::Request.tasks(task_id).update(body: body)
1048
+ task = response.body
1049
+ ```
1050
+ ### <a name="task_complete"></a> [Выполнение задачи](https://www.amocrm.ru/developers/content/crm_platform/tasks-api#tasks-complete)
1051
+ ```ruby
1052
+ body = {
1053
+ is_completed: true,
1054
+ result: {
1055
+ text: "Удалось связаться с клиентом"
1056
+ }
1057
+ }
1058
+ response = AmocrmRails::Request.tasks(task_id).update(body: body)
1059
+ task = response.body
1060
+ ```
1061
+ ## <a name="custom_fields"></a> [Поля и группы полей](https://www.amocrm.ru/developers/content/crm_platform/custom-fields)
1062
+ ### <a name="custom_fields_list"></a> [Список полей сущности](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-list)
1063
+ ```ruby
1064
+ response = AmocrmRails::Request.leads.custom_fields.retrieve
1065
+ ```
1066
+ ```ruby
1067
+ response = AmocrmRails::Request.contacts.custom_fields.retrieve
1068
+ ```
1069
+ ```ruby
1070
+ response = AmocrmRails::Request.companies.custom_fields.retrieve
1071
+ ```
1072
+ ```ruby
1073
+ response = AmocrmRails::Request.customers.custom_fields.retrieve
1074
+ ```
1075
+ ```ruby
1076
+ response = AmocrmRails::Request.customers.segments.custom_fields.retrieve
1077
+ ```
1078
+ ```ruby
1079
+ response = AmocrmRails::Request.catalogs(catalog_id).custom_fields.retrieve
1080
+ ```
1081
+ ```ruby
1082
+ custom_fields = response.body[:_embedded][:custom_fields]
1083
+ ```
1084
+ ### <a name="custom_fields_detail"></a> [Получение поля сущности по его ID](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-field-detail)
1085
+ ```ruby
1086
+ response = AmocrmRails::Request.leads.custom_fields(id).retrieve
1087
+ ```
1088
+ ```ruby
1089
+ response = AmocrmRails::Request.contacts.custom_fields(id).retrieve
1090
+ ```
1091
+ ```ruby
1092
+ response = AmocrmRails::Request.companies.custom_fields(id).retrieve
1093
+ ```
1094
+ ```ruby
1095
+ response = AmocrmRails::Request.customers.custom_fields(id).retrieve
1096
+ ```
1097
+ ```ruby
1098
+ response = AmocrmRails::Request.customers.segments.custom_fields(id).retrieve
1099
+ ```
1100
+ ```ruby
1101
+ response = AmocrmRails::Request.catalogs(catalog_id).custom_fields(id).retrieve
1102
+ ```
1103
+ ```ruby
1104
+ custom_fields = response.body
1105
+ ```
1106
+ ### <a name="custom_fields_add"></a> [Создание дополнительных полей сущности](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-add)
1107
+ ```ruby
1108
+ body = [
1109
+ {
1110
+ name: "multi select",
1111
+ type: "multiselect",
1112
+ sort: 510,
1113
+ required_statuses: [
1114
+ {
1115
+ pipeline_id: 16056,
1116
+ status_id: 20540473
1117
+ }
1118
+ ],
1119
+ enums: [
1120
+ {
1121
+ value: "Значение 1",
1122
+ sort: 1
1123
+ },
1124
+ {
1125
+ value: "Значение 2",
1126
+ sort: 2
1127
+ }
1128
+ ]
1129
+ }
1130
+ ]
1131
+ ```
1132
+ ```ruby
1133
+ response = AmocrmRails::Request.leads.custom_fields.create(body: body)
1134
+ ```
1135
+ ```ruby
1136
+ response = AmocrmRails::Request.contacts.custom_fields.create(body: body)
1137
+ ```
1138
+ ```ruby
1139
+ response = AmocrmRails::Request.companies.custom_fields.create(body: body)
1140
+ ```
1141
+ ```ruby
1142
+ response = AmocrmRails::Request.customers.custom_fields.create(body: body)
1143
+ ```
1144
+ ```ruby
1145
+ response = AmocrmRails::Request.customers.segments.custom_fields.create(body: body)
1146
+ ```
1147
+ ```ruby
1148
+ response = AmocrmRails::Request.catalogs(catalog_id).custom_fields.create(body: body)
1149
+ ```
1150
+ ```ruby
1151
+ custom_fields = response.body[:_embedded][:custom_fields]
1152
+ ```
1153
+ ### <a name="custom_fields_edit"></a> [Редактирование дополнительных полей сущности](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-edit)
1154
+ ```ruby
1155
+ custom_field_id = 1278898087
1156
+ body_items = [{
1157
+ "id": custom_field_id,
1158
+ "name": "Новое имя для дополнительного поля",
1159
+ "sort": 560,
1160
+ "is_visible": false,
1161
+ "is_required": true
1162
+ }]
1163
+ body_item = {
1164
+ "name": "Новое имя для дополнительного поля",
1165
+ "sort": 560,
1166
+ "is_visible": false,
1167
+ "is_required": true
1168
+ }
1169
+ ```
1170
+ ```ruby
1171
+ AmocrmRails::Request.leads.custom_fields.update(body: body_items)
1172
+ AmocrmRails::Request.leads.custom_fields(custom_field_id).update(body: body_item)
1173
+ ```
1174
+ ```ruby
1175
+ AmocrmRails::Request.contacts.custom_fields.update(body: body_items)
1176
+ AmocrmRails::Request.contacts.custom_fields(custom_field_id).update(body: body_item)
1177
+ ```
1178
+ ```ruby
1179
+ AmocrmRails::Request.companies.custom_fields.update(body: body_items)
1180
+ AmocrmRails::Request.companies.custom_fields(custom_field_id).update(body: body_item)
1181
+ ```
1182
+ ```ruby
1183
+ AmocrmRails::Request.customers.custom_fields.update(body: body_items)
1184
+ AmocrmRails::Request.customers.custom_fields(custom_field_id).update(body: body_item)
1185
+ ```
1186
+ ```ruby
1187
+ AmocrmRails::Request.customers.segments.custom_fields.update(body: body_items)
1188
+ AmocrmRails::Request.customers.segments.custom_fields(custom_field_id).update(body: body_item)
1189
+ ```
1190
+ ```ruby
1191
+ AmocrmRails::Request.catalogs(catalog_id).custom_fields.update(body: body_items)
1192
+ AmocrmRails::Request.catalogs(catalog_id).custom_fields(custom_field_id).update(body: body_item)
1193
+ ```
1194
+ ### <a name="custom_fields_delete"></a> [Удаление дополнительного поля](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-field-delete)
1195
+
1196
+ ```ruby
1197
+ AmocrmRails::Request.leads.custom_fields(custom_field_id).delete
1198
+ ```
1199
+ ```ruby
1200
+ AmocrmRails::Request.contacts.custom_fields(custom_field_id).delete
1201
+ ```
1202
+ ```ruby
1203
+ AmocrmRails::Request.companies.custom_fields(custom_field_id).delete
1204
+ ```
1205
+ ```ruby
1206
+ AmocrmRails::Request.customers.custom_fields(custom_field_id).delete
1207
+ ```
1208
+ ```ruby
1209
+ AmocrmRails::Request.customers.segments.custom_fields(custom_field_id).delete
1210
+ ```
1211
+ ```ruby
1212
+ AmocrmRails::Request.catalogs(catalog_id).custom_fields(custom_field_id).delete
1213
+ ```
1214
+ ### <a name="custom_fields_groups_list"></a> [Список групп полей сущности](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-groups-list)
1215
+ ```ruby
1216
+ response = AmocrmRails::Request.leads.custom_fields.groups.retrieve
1217
+ ```
1218
+ ```ruby
1219
+ response = AmocrmRails::Request.contacts.custom_fields.groups.retrieve
1220
+ ```
1221
+ ```ruby
1222
+ response = AmocrmRails::Request.companies.custom_fields.groups.retrieve
1223
+ ```
1224
+ ```ruby
1225
+ response = AmocrmRails::Request.customers.custom_fields.groups.retrieve
1226
+ ```
1227
+ ```ruby
1228
+ custom_field_groups = response[:_embedded][:custom_field_groups]
1229
+ group_id = custom_field_groups.first[:id]
1230
+ ```
1231
+ ### <a name="custom_fields_groups_detail"></a> [Получение группы полей сущности по ID группы](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-group-detail)
1232
+ ```ruby
1233
+ response = AmocrmRails::Request.leads.custom_fields.groups(group_id).retrieve
1234
+ ```
1235
+ ```ruby
1236
+ response = AmocrmRails::Request.contacts.custom_fields.groups(group_id).retrieve
1237
+ ```
1238
+ ```ruby
1239
+ response = AmocrmRails::Request.companies.custom_fields.groups(group_id).retrieve
1240
+ ```
1241
+ ```ruby
1242
+ response = AmocrmRails::Request.customers.custom_fields.groups(group_id).retrieve
1243
+ ```
1244
+ ```ruby
1245
+ group_id = response[:id]
1246
+ ```
1247
+ ### <a name="custom_fields_groups_add"></a> [Создание групп полей](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-groups-add)
1248
+
1249
+ ```ruby
1250
+ body = [
1251
+ {
1252
+ name: "group 1",
1253
+ sort: 4
1254
+ },
1255
+ {
1256
+ name: "group 2",
1257
+ sort: 5
1258
+ }
1259
+ ]
1260
+ ```
1261
+ ```ruby
1262
+ response = AmocrmRails::Request.leads.custom_fields.groups.create(body: body)
1263
+ ```
1264
+ ```ruby
1265
+ response = AmocrmRails::Request.contacts.custom_fields.groups.create(body: body)
1266
+ ```
1267
+ ```ruby
1268
+ response = AmocrmRails::Request.companies.custom_fields.groups.create(body: body)
1269
+ ```
1270
+ ```ruby
1271
+ response = AmocrmRails::Request.customers.custom_fields.groups.create(body: body)
1272
+ ```
1273
+ ```ruby
1274
+ custom_field_groups = response.body[:_embedded][:custom_field_groups]
1275
+ custom_field_group_id = custom_field_groups.first[:id]
1276
+ ```
1277
+ ### <a name="custom_fields_groups_edit"></a> [Редактирование группы полей](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-group-edit)
1278
+
1279
+ ```ruby
1280
+ body = {
1281
+ sort: 6,
1282
+ fields: [
1283
+ 14563,
1284
+ 12575
1285
+ ]
1286
+ }
1287
+ ```
1288
+ ```ruby
1289
+ response = AmocrmRails::Request.leads.custom_fields.groups(custom_field_group_id).update(body: body)
1290
+ ```
1291
+ ```ruby
1292
+ response = AmocrmRails::Request.contacts.custom_fields.groups(custom_field_group_id).update(body: body)
1293
+ ```
1294
+ ```ruby
1295
+ response = AmocrmRails::Request.companies.custom_fields.groups(custom_field_group_id).update(body: body)
1296
+ ```
1297
+ ```ruby
1298
+ response = AmocrmRails::Request.customers.custom_fields.groups(custom_field_group_id).update(body: body)
1299
+ ```
1300
+ ```ruby
1301
+ custom_field_groups = response.body[:_embedded][:custom_field_groups]
1302
+ custom_field_group_id = custom_field_groups.first[:id]
1303
+ ```
1304
+ ### <a name="custom_fields_groups_delete"></a> [Удаление группы дополнительных полей](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#custom-fields-group-delete)
1305
+
1306
+ ```ruby
1307
+ AmocrmRails::Request.leads.custom_fields.groups(custom_field_group_id).delete
1308
+ ```
1309
+ ```ruby
1310
+ AmocrmRails::Request.contacts.custom_fields.groups(custom_field_group_id).delete
1311
+ ```
1312
+ ```ruby
1313
+ AmocrmRails::Request.companies.custom_fields.groups(custom_field_group_id).delete
1314
+ ```
1315
+ ```ruby
1316
+ AmocrmRails::Request.customers.custom_fields.groups(custom_field_group_id).delete
1317
+ ```
1318
+ ### <a name="custom_fields_types"></a> [Доступные типы полей](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#cf-types)
1319
+ ### <a name="custom_fields_examples"></a> [Примеры заполнения разных типов полей через API](https://www.amocrm.ru/developers/content/crm_platform/custom-fields#cf-fill-examples)
1320
+
1321
+ ## <a name="tags"></a> [Теги](https://www.amocrm.ru/developers/content/crm_platform/tags-api)
1322
+ ### <a name="tags_list"></a> [Список тегов для сущности](https://www.amocrm.ru/developers/content/crm_platform/tags-api#tags-list)
1323
+ ```ruby
1324
+ params = {
1325
+ page: 0,
1326
+ limit: 10
1327
+ }
1328
+ ```
1329
+ ```ruby
1330
+ response = AmocrmRails::Request.leads.tags.retrieve(params: params)
1331
+ ```
1332
+ ```ruby
1333
+ response = AmocrmRails::Request.contacts.tags.retrieve(params: params)
1334
+ ```
1335
+ ```ruby
1336
+ response = AmocrmRails::Request.companies.tags.retrieve(params: params)
1337
+ ```
1338
+ ```ruby
1339
+ response = AmocrmRails::Request.customers.tags.retrieve(params: params)
1340
+ ```
1341
+ ```ruby
1342
+ tags = response.body[:_embedded][:tags]
1343
+ tag_id = tags.first[:id]
1344
+ ```
1345
+ ### <a name="tags_add"></a> [Добавление тегов для конкретного типа сущности](https://www.amocrm.ru/developers/content/crm_platform/tags-api#tags-add)
1346
+ ```ruby
1347
+ body = [
1348
+ {
1349
+ "name": "Tag 1"
1350
+ },
1351
+ {
1352
+ "name": "Tag 2",
1353
+ "request_id": "my_request_id"
1354
+ },
1355
+ {
1356
+ "name": "Tag 3"
1357
+ }
1358
+ ]
1359
+ ```
1360
+ ```ruby
1361
+ response = AmocrmRails::Request.leads.tags.create(body: body)
1362
+ ```
1363
+ ```ruby
1364
+ response = AmocrmRails::Request.contacts.tags.create(body: body)
1365
+ ```
1366
+ ```ruby
1367
+ response = AmocrmRails::Request.companies.tags.create(body: body)
1368
+ ```
1369
+ ```ruby
1370
+ response = AmocrmRails::Request.customers.tags.create(body: body)
1371
+ ```
1372
+ ```ruby
1373
+ tags = response.body[:_embedded][:tags]
1374
+ tag_id = tags.first[:id]
1375
+ ```
1376
+ ### <a name="add_tags_to_entity"></a> [Добавление тегов к сущности](https://www.amocrm.ru/developers/content/crm_platform/tags-api#add-tags-to-entity)
1377
+ ```ruby
1378
+ body_item = {
1379
+ "_embedded": {
1380
+ "tags": [
1381
+ {
1382
+ "id": tag_id
1383
+ }
1384
+ ]
1385
+ }
1386
+ }
1387
+ body = [
1388
+ {
1389
+ "id": object_id,
1390
+ "_embedded": {
1391
+ "tags": [
1392
+ {
1393
+ "id": tag_id
1394
+ }
1395
+ ]
1396
+ }
1397
+ }
1398
+ ]
1399
+ ```
1400
+ ```ruby
1401
+ AmocrmRails::Request.leads.update(body: body)
1402
+ AmocrmRails::Request.leads(lead_id).update(body: body_item)
1403
+ ```
1404
+ ```ruby
1405
+ AmocrmRails::Request.contacts.update(body: body)
1406
+ AmocrmRails::Request.contacts(contact_id).update(body: body_item)
1407
+ ```
1408
+ ```ruby
1409
+ AmocrmRails::Request.companies.update(body: body)
1410
+ AmocrmRails::Request.contacts(company_id).update(body: body_item)
1411
+ ```
1412
+ ```ruby
1413
+ AmocrmRails::Request.customers.update(body: body)
1414
+ AmocrmRails::Request.contacts(customer_id).update(body: body_item)
1415
+ ```
1416
+ ### <a name="delete_tags_from_entity"></a> [Удаление тегов у сущности](https://www.amocrm.ru/developers/content/crm_platform/tags-api#delete-tags-from-entity)
1417
+
1418
+ ```ruby
1419
+ body_item = {
1420
+ "_embedded": {
1421
+ "tags": nil
1422
+ }
1423
+ }
1424
+ body = [
1425
+ {
1426
+ "id": object_id,
1427
+ "_embedded": {
1428
+ "tags": nil
1429
+ }
1430
+ }
1431
+ ]
1432
+ ```
1433
+ ```ruby
1434
+ AmocrmRails::Request.leads.update(body: body)
1435
+ AmocrmRails::Request.leads(lead_id).update(body: body_item)
1436
+ ```
1437
+ ```ruby
1438
+ AmocrmRails::Request.contacts.update(body: body)
1439
+ AmocrmRails::Request.contacts(contact_id).update(body: body_item)
1440
+ ```
1441
+ ```ruby
1442
+ AmocrmRails::Request.companies.update(body: body)
1443
+ AmocrmRails::Request.contacts(company_id).update(body: body_item)
1444
+ ```
1445
+ ```ruby
1446
+ AmocrmRails::Request.customers.update(body: body)
1447
+ AmocrmRails::Request.contacts(customer_id).update(body: body_item)
1448
+ ```
1449
+ ## <a name="events_and_notes"></a> [События и примечания](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes)
1450
+ ### <a name="events_list"></a> [Список событий](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-list)
1451
+
1452
+ ```ruby
1453
+ params = {
1454
+ with: 'contact_name',
1455
+ page: 0,
1456
+ limit: 10
1457
+ }
1458
+ ```
1459
+ ```ruby
1460
+ response = AmocrmRails::Request.events.retrieve(params: params)
1461
+ events = response.body[:_embedded][:events]
1462
+ event_id = events.first[:id]
1463
+ ```
1464
+ ### <a name="events_detail"></a> [Получение события по ID](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-detail)
1465
+
1466
+ ```ruby
1467
+ params = {
1468
+ with: 'contact_name'
1469
+ }
1470
+ ```
1471
+ ```ruby
1472
+ response = AmocrmRails::Request.events(event_id).retrieve(params: params)
1473
+ event = response.body
1474
+ ```
1475
+ ### <a name="events_filter_params"></a> [Значения для фильтра по значению до/после](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-filter-params)
1476
+
1477
+ ```ruby
1478
+ filter = {
1479
+ filter: {
1480
+ value_after: [
1481
+ customers_statuses: [
1482
+ {
1483
+ status_id: 135751,
1484
+ },
1485
+ {
1486
+ status_id: 135754,
1487
+ }
1488
+ ]
1489
+ ]
1490
+ }
1491
+ }
1492
+ ```
1493
+ ```ruby
1494
+ filter = {
1495
+ filter: {
1496
+ value_after: [
1497
+ value: '155',
1498
+ ],
1499
+ type: 'sale_field_changed',
1500
+ entity: 'lead'
1501
+ }
1502
+ }
1503
+ ```
1504
+ ### <a name="events_types"></a> [Типы событий](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-types)
1505
+
1506
+ ```ruby
1507
+ params = {
1508
+ language_code: 'en'
1509
+ }
1510
+ ```
1511
+ ```ruby
1512
+ response = AmocrmRails::Request.events.types.retrieve(params: params)
1513
+ events_types = response.body[:_embedded][:events_types]
1514
+ ```
1515
+
1516
+ ### <a name="notes_common_info"></a> [Общая информация о примечаниях](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-common-info)
1517
+ ### <a name="notes_types"></a> [Типы примечаний](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-types)
1518
+ ### <a name="notes_list"></a> [Список примечаний по типу сущности](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-list)
1519
+ ```ruby
1520
+ params = {
1521
+ page: 0,
1522
+ limit: 10
1523
+ }
1524
+ ```
1525
+ ```ruby
1526
+ response = AmocrmRails::Request.leads.notes.retrieve(params: params)
1527
+ ```
1528
+ ```ruby
1529
+ response = AmocrmRails::Request.contacts.notes.retrieve(params: params)
1530
+ ```
1531
+ ```ruby
1532
+ response = AmocrmRails::Request.companies.notes.retrieve(params: params)
1533
+ ```
1534
+ ```ruby
1535
+ response = AmocrmRails::Request.customers.notes.retrieve(params: params)
1536
+ ```
1537
+ ```ruby
1538
+ notes = response.body[:_embedded][:notes]
1539
+ note_id = notes.first[:id]
1540
+ ```
1541
+
1542
+ ### <a name="notes_entity_list"></a> [Список примечаний по конкретной сущности, по ID сущности](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-entity-list)
1543
+ ```ruby
1544
+ params = {
1545
+ page: 0,
1546
+ limit: 10
1547
+ }
1548
+ ```
1549
+ ```ruby
1550
+ response = AmocrmRails::Request.leads(lead_id).notes.retrieve(params: params)
1551
+ ```
1552
+ ```ruby
1553
+ response = AmocrmRails::Request.contacts(contact_id).notes.retrieve(params: params)
1554
+ ```
1555
+ ```ruby
1556
+ response = AmocrmRails::Request.companies(company_id).notes.retrieve(params: params)
1557
+ ```
1558
+ ```ruby
1559
+ response = AmocrmRails::Request.customers(customer_id).notes.retrieve(params: params)
1560
+ ```
1561
+ ```ruby
1562
+ notes = response.body[:_embedded][:notes]
1563
+ note_id = notes.first[:id]
1564
+ ```
1565
+
1566
+ ### <a name="note_detail"></a> [Получение примечания по ID](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#note-detail)
1567
+ ```ruby
1568
+ response = AmocrmRails::Request.leads(lead_id).notes(note_id).retrieve
1569
+ ```
1570
+ ```ruby
1571
+ response = AmocrmRails::Request.contacts(contact_id).notes(note_id).retrieve
1572
+ ```
1573
+ ```ruby
1574
+ response = AmocrmRails::Request.companies(company_id).notes(note_id).retrieve
1575
+ ```
1576
+ ```ruby
1577
+ response = AmocrmRails::Request.customers(customer_id).notes(note_id).retrieve
1578
+ ```
1579
+ ```ruby
1580
+ note = response.body
1581
+ ```
1582
+
1583
+ ### <a name="notes_add"></a> [Добавление примечаний](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-add)
1584
+
1585
+ ```ruby
1586
+ body = [
1587
+ {
1588
+ entity_id: 167353,
1589
+ note_type: "call_in",
1590
+ params: {
1591
+ uniq: "8f52d38a-5fb3-406d-93a3-a4832dc28f8b",
1592
+ duration: 60,
1593
+ source: "onlinePBX",
1594
+ link: "https://example.com",
1595
+ phone: "+79999999999"
1596
+ }
1597
+ },
1598
+ {
1599
+ entity_id: 167353,
1600
+ note_type: "call_out",
1601
+ params: {
1602
+ uniq: "8f52d38a-5fb3-406d-93a3-a4832dc28f8b",
1603
+ duration: 60,
1604
+ source: "onlinePBX",
1605
+ link: "https://example.com",
1606
+ phone: "+79999999999"
1607
+ }
1608
+ },
1609
+ {
1610
+ entity_id: 167353,
1611
+ note_type: "geolocation",
1612
+ params: {
1613
+ text: "Примечание с геолокацией",
1614
+ address: "ул. Пушкина, дом Колотушкина, квартира Вольнова",
1615
+ longitude: "53.714816",
1616
+ latitude: "91.423146"
1617
+ }
1618
+ }
1619
+ ]
1620
+ body_item = {
1621
+ entity_id: 167353,
1622
+ note_type: "call_in",
1623
+ params: {
1624
+ uniq: "8f52d38a-5fb3-406d-93a3-a4832dc28f8b",
1625
+ duration: 60,
1626
+ source: "onlinePBX",
1627
+ link: "https://example.com",
1628
+ phone: "+79999999999"
1629
+ }
1630
+ }
1631
+ ```
1632
+
1633
+ ```ruby
1634
+ AmocrmRails::Request.leads.notes.create(body: body)
1635
+ AmocrmRails::Request.leads(lead_id).notes.create(body: body_item)
1636
+ ```
1637
+ ```ruby
1638
+ AmocrmRails::Request.contacts.notes.create(body: body)
1639
+ AmocrmRails::Request.contacts(contact_id).notes.create(body: body_item)
1640
+ ```
1641
+ ```ruby
1642
+ AmocrmRails::Request.companies.notes.create(body: body)
1643
+ AmocrmRails::Request.companies(company_id).notes.create(body: body_item)
1644
+ ```
1645
+ ```ruby
1646
+ AmocrmRails::Request.customers.notes.create(body: body)
1647
+ AmocrmRails::Request.customers(customer_id).notes.create(body: body_item)
1648
+ ```
1649
+ ```ruby
1650
+ notes = response.body[:_embedded][:notes]
1651
+ note_id = notes.first[:id]
1652
+ ```
1653
+
1654
+ ### <a name="notes_edit"></a> [Редактирование примечаний](https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-edit)
1655
+
1656
+ ```ruby
1657
+ body = [
1658
+ {
1659
+ entity_id: 167353,
1660
+ note_type: "call_in",
1661
+ params: {
1662
+ uniq: "8f52d38a-5fb3-406d-93a3-a4832dc28f8b",
1663
+ duration: 60,
1664
+ source: "onlinePBX",
1665
+ link: "https://example.com",
1666
+ phone: "+79999999999"
1667
+ }
1668
+ },
1669
+ {
1670
+ entity_id: 167353,
1671
+ note_type: "call_out",
1672
+ params: {
1673
+ uniq: "8f52d38a-5fb3-406d-93a3-a4832dc28f8b",
1674
+ duration: 60,
1675
+ source: "onlinePBX",
1676
+ link: "https://example.com",
1677
+ phone: "+79999999999"
1678
+ }
1679
+ },
1680
+ {
1681
+ entity_id: 167353,
1682
+ note_type: "geolocation",
1683
+ params: {
1684
+ text: "Примечание с геолокацией",
1685
+ address: "ул. Пушкина, дом Колотушкина, квартира Вольнова",
1686
+ longitude: "53.714816",
1687
+ latitude: "91.423146"
1688
+ }
1689
+ }
1690
+ ]
1691
+ body_item = {
1692
+ entity_id: 167353,
1693
+ note_type: "call_in",
1694
+ params: {
1695
+ uniq: "8f52d38a-5fb3-406d-93a3-a4832dc28f8b",
1696
+ duration: 60,
1697
+ source: "onlinePBX",
1698
+ link: "https://example.com",
1699
+ phone: "+79999999999"
1700
+ }
1701
+ }
1702
+ ```
1703
+
1704
+ ```ruby
1705
+ AmocrmRails::Request.leads.notes.update(body: body)
1706
+ AmocrmRails::Request.leads(lead_id).notes.update(body: body_item)
1707
+ ```
1708
+ ```ruby
1709
+ AmocrmRails::Request.contacts.notes.update(body: body)
1710
+ AmocrmRails::Request.contacts(contact_id).notes.update(body: body_item)
1711
+ ```
1712
+ ```ruby
1713
+ AmocrmRails::Request.companies.notes.update(body: body)
1714
+ AmocrmRails::Request.companies(company_id).notes.update(body: body_item)
1715
+ ```
1716
+ ```ruby
1717
+ AmocrmRails::Request.customers.notes.update(body: body)
1718
+ AmocrmRails::Request.customers(customer_id).notes.update(body: body_item)
1719
+ ```
1720
+ ```ruby
1721
+ notes = response.body[:_embedded][:notes]
1722
+ note_id = notes.first[:id]
1723
+ ```
1724
+
1725
+ ## <a name="customers"></a> [Покупатели](https://www.amocrm.ru/developers/content/crm_platform/customers-api)
1726
+ ### <a name="customers_mode"></a> [Включение покупателей и смена их режима](https://www.amocrm.ru/developers/content/crm_platform/customers-api#customers-mode)
1727
+ ```ruby
1728
+ body = {
1729
+ mode: "segments",
1730
+ is_enabled: true
1731
+ }
1732
+ response = AmocrmRails::Request.customers.mode.update(body: body)
1733
+ p(response.body)
1734
+ ```
1735
+ ### <a name="customers_list"></a> [Список покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-api#customers-list)
1736
+ ```ruby
1737
+ params = {
1738
+ with: 'contacts',
1739
+ page: 0,
1740
+ limit: 10
1741
+ }
1742
+ response = AmocrmRails::Request.customers.retrieve(params: params)
1743
+ customers = response.body[:_embedded][:customers]
1744
+ customer_id = customers.first[:id]
1745
+ ```
1746
+ ### <a name="customers_detail"></a> [Получение покупателя по ID](https://www.amocrm.ru/developers/content/crm_platform/customers-api#customer-detail)
1747
+ ```ruby
1748
+ params = {
1749
+ with: 'contacts'
1750
+ }
1751
+ response = AmocrmRails::Request.customers(customer_id).retrieve(params: params)
1752
+ customer = response.body
1753
+ ```
1754
+ ### <a name="customers_add"></a> [Добавление покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-api#customers-add)
1755
+ ```ruby
1756
+ body = [
1757
+ {
1758
+ name: "Покупатель для примера 1",
1759
+ created_by: 0
1760
+ },
1761
+ {
1762
+ name: "Покупатель для примера 2",
1763
+ _embedded: {
1764
+ tags: [
1765
+ {
1766
+ "name": "Важный покупатель"
1767
+ }
1768
+ ]
1769
+ }
1770
+ }
1771
+ ]
1772
+ response = AmocrmRails::Request.customers.create(body: body)
1773
+ customers = response.body[:_embedded][:customers]
1774
+ customer_id = customers.first[:id]
1775
+ ```
1776
+ ### <a name="customers_edit"></a> [Редактирование покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-api#customers-edit)
1777
+ ```ruby
1778
+ body = [
1779
+ {
1780
+ id: customer_id,
1781
+ name: "Новое название покупателя",
1782
+ _embedded: {
1783
+ tags: [
1784
+ {
1785
+ name: "Тег 125"
1786
+ }
1787
+ ]
1788
+ }
1789
+ }
1790
+ ]
1791
+ response = AmocrmRails::Request.customers.update(body: body)
1792
+ customers = response.body[:_embedded][:customers]
1793
+ customer_id = customers.first[:id]
1794
+ ```
1795
+ ### <a name="customer_edit"></a> [Редактирование покупателя](https://www.amocrm.ru/developers/content/crm_platform/customers-api#customers-edit)
1796
+ ```ruby
1797
+ body = {
1798
+ name: "Новое название покупателя",
1799
+ _embedded: {
1800
+ tags: [
1801
+ {
1802
+ name: "Тег 125"
1803
+ }
1804
+ ]
1805
+ }
1806
+ }
1807
+ response = AmocrmRails::Request.customers(customer_id).update(body: body)
1808
+ customer = response.body
1809
+ ```
1810
+ ### <a name="transactions_list"></a> [Список транзакций](https://www.amocrm.ru/developers/content/crm_platform/customers-api#transactions-list)
1811
+ ```ruby
1812
+ params = {
1813
+ page: 0,
1814
+ limit: 10
1815
+ }
1816
+ response = AmocrmRails::Request.customers.transactions.retrieve(params: params)
1817
+ response = AmocrmRails::Request.customers(customer_id).transactions.retrieve(params: params)
1818
+
1819
+ transactions = response.body[:_embedded][:transactions]
1820
+ transaction_id = transactions.first[:id]
1821
+ ```
1822
+ ### <a name="transactions_detail"></a> [Получение транзакции по ID](https://www.amocrm.ru/developers/content/crm_platform/customers-api#transaction-detail)
1823
+ ```ruby
1824
+ response = AmocrmRails::Request.customers.transactions(transaction_id).retrieve
1825
+ response = AmocrmRails::Request.customers(customer_id).transactions(transaction_id).retrieve
1826
+
1827
+ transaction = response.body
1828
+ ```
1829
+ ### <a name="transactions_add"></a> [Добавление транзакций к покупателю](https://www.amocrm.ru/developers/content/crm_platform/customers-api#transactions-add)
1830
+ ```ruby
1831
+ body = [
1832
+ {
1833
+ price: 123,
1834
+ created_by: 0,
1835
+ comment: "Комментарий",
1836
+ _embedded: {
1837
+ catalog_elements: [
1838
+ {
1839
+ id: 1677,
1840
+ metadata: {
1841
+ catalog_id: 1079,
1842
+ quantity: 10
1843
+ }
1844
+ }
1845
+ ]
1846
+ }
1847
+ }
1848
+ ]
1849
+ response = AmocrmRails::Request.customers(customer_id).transactions.create(body: body)
1850
+ p(response.body)
1851
+ transactions = response.body[:_embedded][:transactions]
1852
+ transaction_id = transactions.first[:id]
1853
+ ```
1854
+ ### <a name="transaction_delete"></a> [Удаление транзакции](https://www.amocrm.ru/developers/content/crm_platform/customers-api#transaction-delete)
1855
+
1856
+ ```ruby
1857
+ response = AmocrmRails::Request.customers.transactions(transaction_id).delete
1858
+ p(response.body)
1859
+ ```
1860
+ ### <a name="customer_bonus_points_update"></a> [Списание/начисление бонусных баллов покупателю](https://www.amocrm.ru/developers/content/crm_platform/customers-api#customer–bonus-points-update)
1861
+
1862
+ ```ruby
1863
+ body = {
1864
+ earn: 500
1865
+ }
1866
+ response = AmocrmRails::Request.customers(customer_id).bonus_points.create(body: body)
1867
+ p(response.body)
1868
+ ```
1869
+ ## <a name="customers_statuses"></a> [Статусы и сегменты покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api)
1870
+ ### <a name="customers_statuses_list"></a> [Список статусов покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#customers-statuses-list)
1871
+ ```ruby
1872
+ response = AmocrmRails::Request.customers.statuses.retrieve
1873
+ statuses = response.body[:_embedded][:statuses]
1874
+ status_id = statuses.first[:id]
1875
+ ```
1876
+ ### <a name="customers_statuses_detail"></a> [Получение статуса покупателей по ID](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#customer-status-detail)
1877
+ ```ruby
1878
+ response = AmocrmRails::Request.customers.statuses(status_id).retrieve
1879
+ statuses = response.body[:_embedded][:statuses]
1880
+ status_id = statuses.first[:id]
1881
+ ```
1882
+ ### <a name="customers_statuses_add"></a> [Добавление статусов в воронку](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#customers-statuses-add)
1883
+ ### <a name="customers_statuses_edit"></a> [Редактирование статуса покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#customers-status-edit)
1884
+ ### <a name="customer_status_delete"></a> [Удаление статуса покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#customer-status-delete)
1885
+ ### <a name="segments_list"></a> [Список сегментов покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#segments-list)
1886
+ ### <a name="segments_detail"></a> [Получение сегмента покупателей по ID](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#segment-detail)
1887
+ ### <a name="segments_add"></a> [Добавление сегмента покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#segment-add)
1888
+ ### <a name="segments_edit"></a> [Редактирование сегмента покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#segment-edit)
1889
+ ### <a name="segment_delete"></a> [Удаление сегмента покупателей](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#segment-delete)
1890
+ ### <a name="customers_statuses_colors"></a> [Доступные цвета статусов](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#customers-statuses-colors)
1891
+ ### <a name="customers_statuses_colors"></a> [Доступные цвета сегментов](https://www.amocrm.ru/developers/content/crm_platform/customers-statuses-api#segments-colors)
1892
+
1893
+ ## <a name="users"></a> [Пользователи](https://www.amocrm.ru/developers/content/crm_platform/users-api)
1894
+ ### <a name="users_list"></a> [Список пользователей](https://www.amocrm.ru/developers/content/crm_platform/users-api#users-list)
1895
+ ### <a name="users_detail"></a> [Получение пользователя по ID](https://www.amocrm.ru/developers/content/crm_platform/users-api#user-detail)
1896
+ ### <a name="users_add"></a> [Добавление пользователей](https://www.amocrm.ru/developers/content/crm_platform/users-api#users-add)
1897
+ ### <a name="roles_list"></a> [Список ролей пользователей](https://www.amocrm.ru/developers/content/crm_platform/users-api#roles-list)
1898
+ ### <a name="roles_detail"></a> [Получение роли по ID](https://www.amocrm.ru/developers/content/crm_platform/users-api#role-detail)
1899
+ ### <a name="roles_add"></a> [Добавление ролей](https://www.amocrm.ru/developers/content/crm_platform/users-api#roles-add)
1900
+ ### <a name="roles_edit"></a> [Редактирование роли](https://www.amocrm.ru/developers/content/crm_platform/users-api#role-edit)
1901
+ ### <a name="roles_delete"></a> [Удаление роли](https://www.amocrm.ru/developers/content/crm_platform/users-api#role-delete)
1902
+ ### <a name="users_common_rights"></a> [Общие обозначения прав пользователей](https://www.amocrm.ru/developers/content/crm_platform/users-api#common-rights)
1903
+ ### <a name="users_rights_dependence"></a> [Зависимости прав пользователей](https://www.amocrm.ru/developers/content/crm_platform/users-api#rights-dependence)
1904
+
1905
+ ## <a name="products"></a> [Товары](https://www.amocrm.ru/developers/content/crm_platform/products-api)
1906
+ ## <a name="webhooks"></a> [Вебхуки](https://www.amocrm.ru/developers/content/crm_platform/webhooks-api)
1907
+ ### <a name="webhooks_list"></a> [Список установленных вебхуков в аккаунте](https://www.amocrm.ru/developers/content/crm_platform/webhooks-api#webhooks-list)
1908
+ ### <a name="webhooks_subscribe"></a> [Подписка на вебхук](https://www.amocrm.ru/developers/content/crm_platform/webhooks-api#webhook-subscribe)
1909
+ ### <a name="webhooks_delete"></a> [Отписка от событий](https://www.amocrm.ru/developers/content/crm_platform/webhooks-api#webhooks-delete)
1910
+ ### <a name="webhooks_available_actions"></a> [Возможные событий](https://www.amocrm.ru/developers/content/crm_platform/webhooks-api#webhooks-available-actions)
1911
+
1912
+ ## <a name="widgets"></a> [Виджеты](https://www.amocrm.ru/developers/content/crm_platform/widgets-api)
1913
+ ### <a name="widgets_list"></a> [Список виджетов](https://www.amocrm.ru/developers/content/crm_platform/widgets-api#widgets-list)
1914
+ ### <a name="widgets_detail"></a> [Информация о виджете по его коду](https://www.amocrm.ru/developers/content/crm_platform/widgets-api#widget-detail)
1915
+ ### <a name="widgets_install"></a> [Установка виджета в аккаунт](https://www.amocrm.ru/developers/content/crm_platform/widgets-api#widget-install)
1916
+ ### <a name="widgets_uninstall"></a> [Удаление установки виджета](https://www.amocrm.ru/developers/content/crm_platform/widgets-api#widget-uninstall)
1917
+ ### <a name="widgets_continue"></a> [Подтверждение выполнения блока виджета в Salesbot](https://www.amocrm.ru/developers/content/crm_platform/widgets-api#widget-continue)
1918
+
1919
+ ## <a name="calls"></a> [Добавление звонков](https://www.amocrm.ru/developers/content/crm_platform/calls-api)
1920
+
1921
+ ## <a name="salesbot"></a> [Salebot](https://www.amocrm.ru/developers/content/api/salesbot-api)
1922
+
1923
+ ## <a name="short_links"></a> [Короткие ссылки](https://www.amocrm.ru/developers/content/crm_platform/short_links)