#Обновить валюту

PATCH /v1/currencies/:id

Обновляет поля валюты по коду. Используйте для обновления курса обмена.

#Параметры пути

Параметр Тип Описание
id string Код валюты (RUB, USD, EUR)

#Параметры тела запроса

Параметр Тип Описание
amount number Курс обмена
amountCnt number Номинал для курса
sort number Порядок сортировки
LANG object Локализация: название и формат отображения валюты (см. ниже)

Локализуемые поля пишутся только через LANG. Поля fullName, formatString, decimals, decPoint, thousandsSep в Битрикс24 хранятся в структуре локализации и при плоской записи молча игнорируются (запрос вернёт успех, значения не сохранятся). Передавайте их через объект LANG:

JSON 
{ "LANG": { "ru": { "FULL_NAME": "Китайский юань", "FORMAT_STRING": "# ¥", "DECIMALS": 2, "DEC_POINT": ".", "THOUSANDS_SEP": " " } } }

На чтении API уплощает локализацию текущего языка обратно в fullName / formatString / decimals / decPoint / thousandsSep.

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/currencies/USD" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount": 94.2}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/currencies/USD" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount": 94.2}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies/USD', {
  method: 'PATCH',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ amount: 94.2 }),
})
const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies/USD', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ amount: 94.2 }),
})
const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
data boolean true при успешном выполнении

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

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

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

JSON 
{
  "success": false,
  "error": { "code": "NOT_FOUND", "message": "Currency not found" }
}

#Ошибки

HTTP Код Описание
404 NOT_FOUND Валюта не найдена
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

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

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