#Добавить получателей

POST /v1/posts/:id/share

Открывает доступ к посту дополнительным получателям — они увидят его в своей Ленте новостей Битрикс24. Добавляет получателей к тем, кому пост уже был адресован.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID поста. Список: GET /v1/posts

#Поля запроса (body)

Поле Тип Обяз. Описание
recipients string[] да Дополнительные получатели поста (можно комбинировать в массиве):
UA — все сотрудники портала,
U<id> — сотрудник (GET /v1/users),
D<id> — отдел без подотделов,
DR<id> — отдел с подотделами (GET /v1/departments),
SG<id> — рабочая группа или проект (GET /v1/workgroups)

#Примеры

#curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/posts/293/share" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recipients": ["SG5", "U1"]}'

#curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/posts/293/share" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"recipients": ["SG5", "U1"]}'

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/posts/293/share', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ recipients: ['SG5', 'U1'] }),
})
const { data } = await res.json()
console.log('Получатели добавлены:', data)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/posts/293/share', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ recipients: ['SG5', 'U1'] }),
})
const { data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true — пост открыт указанным получателям

#Пример ответа

JSON 
{
  "success": true,
  "data": true
}

#Пример ответа при ошибке

404 — пост не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "POST_NOT_FOUND",
    "message": "Post 999999999 not found or not accessible with this key."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_POST_ID ID поста не положительное целое число
400 MISSING_PARAMS recipients не передан, не массив или пустой
400 INVALID_RECIPIENTS Битрикс24 отклонил получателей как неверные
401 TOKEN_MISSING У API-ключа не настроены токены доступа
403 SCOPE_DENIED У API-ключа нет скоупа log
403 BITRIX_ACCESS_DENIED Нет прав на изменение получателей этого поста
404 POST_NOT_FOUND Пост с указанным ID не найден или недоступен ключу
404 POST_NOT_FOUND_OR_INVALID_RECIPIENTS Пост существует, но Битрикс24 отклонил добавление получателей — пост недоступен либо один из получателей неверный

Полный список общих ошибок API — Ошибки.

#Известные особенности

  • Получатели добавляются, а не заменяются. Адресаты, переданные в recipients, добавляются к аудитории, которой пост был открыт при создании. Чтобы задать весь набор получателей заново, обновите пост через PATCH /v1/posts/:id.

#Смотрите также