Для разработчиков

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

POST/tasks
tasks:create

Создаёт напоминание и назначает на него ответственных.

При создании напоминания обязательно указать его тип: звонок, встреча, простое напоминание, событие или письмо. Описание при этом не требуется — напоминание создастся с текстом по типу. Если описание передано, именно оно и станет текстом напоминания.

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

Ответственным для напоминания без привязки к каким-либо сущностям может стать любой сотрудник компании. Актуальный состав сотрудников компании вы можете получить в методе GETСписок сотрудников. Если сотрудника с идентификатором из performer_ids не существует, метод отвечает 404. Если вызывающий сотрудника не видит, ответ — 403: так бывает с сотрудником другого пространства, приостановленным или удалённым, а у гостя — с теми, с кем у него нет общих чатов. Напоминание в обоих случаях не создаётся.

Напоминание можно привязать к беседе полем chat_id — тогда кроме автора и ответственных его видят участники этой беседы. Привязывающий должен сам в ней состоять. В канале, в треде и в архивном чате напоминания не создаются.

Передать напоминание другому сотруднику — значит сменить ответственного методом PUTРедактирование напоминания.

Если к пространству или к профилю подключён календарь, напоминание заодно появляется в нём событием.

Тело запроса

application/json
task
object
*
Собранный объект параметров создаваемого напоминания
kind
string
*
Тип
Возможные значения
Пример:reminder
content
string
Описание, по умолчанию — название типа. До 40 000 байт в UTF-8.
Пример:Забрать со склада 21 заказ
due_at
string, (date-time)
Срок выполнения напоминания (ISO-8601). Смещение вида +03:00 учитывается, время без смещения считается UTC. Секунды отбрасываются: срок встаёт на начало минуты. Исключение — ровно 23:59:59: такое напоминание создаётся на весь день, без указания времени.
Пример:2020-06-05T12:00:00.000+03:00
priority
integer, (int32)
Приоритет: 1, 2 (важно) или 3 (очень важно)
Пример:2
По умолчанию:
1
Диапазон:
1 — 3
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. null, если срок не задан.
Пример:2020-06-05T09:00:00.000Z
priority
integer, (int32)
*
Приоритет
Пример:2
user_id
integer, (int32)
*
Идентификатор пользователя-создателя напоминания
Пример:12
chat_id
nullableinteger, (int32)
*
Идентификатор чата, к которому привязано напоминание. null, если напоминание не привязано к чату.
Пример: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
*
Название поля
Пример:Город
Длина:
<= 32 символов
data_type
string
*
Тип поля
Возможные значения
Пример:string
value
nullablestring
*
Значение. Возвращается null, если поле не заполнено. Число передаётся строкой, дата — в формате ISO 8601.
Пример:Санкт-Петербург
Длина:
<= 768 символов
Новое напоминание
pachca tasks create \  --kind=reminder \  --content='Забрать со склада 21 заказ' \  --due-at=2020-06-05T12:00:00.000+03:00 \  --priority=2 \  --performer-ids='[12,13]' \  --chat-id=456 \  --no-all-day \  --custom-properties='[{"id":78,"value":"Синий склад"}]' \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 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": "Санкт-Петербург"      }    ]  }}