Основы API
Методы API

Новое напоминание

POST/tasks
tasks:create

Метод для создания нового напоминания.

При создании напоминания обязательным условием является указания типа напоминания: звонок, встреча, простое напоминание, событие или письмо. При этом не требуется дополнительное описание - вы просто создадите напоминание с соответствующим текстом. Если вы укажите описание напоминания - то именно оно и станет текстом напоминания.

У напоминания должны быть ответственные, если их не указывать - ответственным назначается вы.

Ответственным для напоминания без привязки к каким-либо сущностям может стать любой сотрудник компании. Актуальный состав сотрудников компании вы можете получить в методе GETсписок сотрудников.

Напоминание можно привязать к чату, указав chat_id. Для привязки к чату необходимо быть его участником.

Тело запроса

application/json
task
object
*
Собранный объект параметров создаваемого напоминания
kind
string
*
Тип
Возможные значения
Пример:reminder
content
string
Описание (по умолчанию — название типа)
Пример:Забрать со склада 21 заказ
due_at
string, (date-time)
Срок выполнения напоминания (ISO-8601) в формате YYYY-MM-DDThh:mm:ss.sssTZD. Если указано время 23:59:59.000, то напоминание будет создано на весь день (без указания времени).
Пример:2020-06-05T12:00:00.000+03:00
priority
integer, (int32)
Приоритет: 1, 2 (важно) или 3 (очень важно).
Пример:2
По умолчанию:
1
performer_ids[]
array of integers, (int32)
Массив идентификаторов пользователей, привязываемых к напоминанию как «ответственные» (по умолчанию ответственным назначается вы)
Пример:[12,13]
chat_id
integer, (int32)
Идентификатор чата, к которому привязывается напоминание
Пример:456
all_day
boolean
Напоминание на весь день (без указания времени)
Пример:false
custom_properties[]
array of objects
Задаваемые дополнительные поля
id
integer, (int32)
*
Идентификатор поля
Пример:78
value
string
*
Устанавливаемое значение
Пример:Синий склад

Ответ

201Created
The request has succeeded and a new resource has been created as a result.
data
object
*
Напоминание
id
integer, (int32)
*
Идентификатор напоминания
Пример:22283
kind
string
*
Тип
Возможные значения
Пример:reminder
content
string
*
Описание
Пример:Забрать со склада 21 заказ
due_at
nullablestring, (date-time)
*
Срок выполнения напоминания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2020-06-05T09:00:00.000Z
priority
integer, (int32)
*
Приоритет
Пример:2
user_id
integer, (int32)
*
Идентификатор пользователя-создателя напоминания
Пример:12
chat_id
nullableinteger, (int32)
*
Идентификатор чата, к которому привязано напоминание
Пример:334
status
string
*
Статус напоминания
Возможные значения
Пример:undone
created_at
string, (date-time)
*
Дата и время создания напоминания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2020-06-04T10:37:57.000Z
performer_ids[]
array of integers, (int32)
*
Массив идентификаторов пользователей, привязанных к напоминанию как «ответственные»
Пример:[12]
all_day
boolean
*
Напоминание на весь день (без указания времени)
Пример:false
custom_properties[]
array of objects
*
Дополнительные поля напоминания
id
integer, (int32)
*
Идентификатор поля
Пример:1678
name
string
*
Название поля
Пример:Город
data_type
string
*
Тип поля
Возможные значения
Пример:string
value
string
*
Значение
Пример:Санкт-Петербург
Новое напоминание
curl "https://api.pachca.com/api/shared/v1/tasks" \  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{  "task": {    "kind": "reminder",    "content": "Забрать со склада 21 заказ",    "due_at": "2020-06-05T12:00:00.000+03:00",    "priority": 2,    "performer_ids": [      12,      13    ],    "chat_id": 456,    "all_day": false,    "custom_properties": [      {        "id": 78,        "value": "Синий склад"      }    ]  }}'
Ответ 201
{  "data": {    "id": 22283,    "kind": "reminder",    "content": "Забрать со склада 21 заказ",    "due_at": "2020-06-05T09:00:00.000Z",    "priority": 2,    "user_id": 12,    "chat_id": 334,    "status": "undone",    "created_at": "2020-06-04T10:37:57.000Z",    "performer_ids": [      12    ],    "all_day": false,    "custom_properties": [      {        "id": 1678,        "name": "Город",        "data_type": "string",        "value": "Санкт-Петербург"      }    ]  }}