Удалить банковский реквизит

DELETE /v1/bank-details/:id

Удаляет банковский реквизит по ID. Восстановить удалённую запись через API нельзя — создавайте новую при необходимости.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID банковского реквизита

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/bank-details/19" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/bank-details/19" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details/19', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Банковский реквизит удалён')
}

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details/19', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

if (res.status === 204) {
  console.log('Удалено')
}

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом. Признак успеха — код ответа, не содержимое.

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

HTTP/1.1 204 No Content

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

404 — банковский реквизит не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The RequisiteBankDetail with ID '999999' is not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Банковский реквизит с таким ID не найден
403 SCOPE_DENIED Ключ не имеет скоупа crm. Сообщение: This endpoint requires 'crm' scope
401 TOKEN_MISSING Не передан X-Api-Key

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

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