لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/entities/currencies/localizations/delete.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Delete currency localizations

DELETE /v1/currencies/:id/localizations

Deletes the currency display settings for the specified languages. If needed, create them again with the localizations write method.

Scope: crm.

Parameters

Parameter Type Required Default Description
Parameterid (path) Typestring Requiredyes Default— DescriptionCurrency code from the currency list. Leading and trailing spaces are stripped, letters are uppercased
Parameterlangs (query) Typestring Requiredyes Default— DescriptionLanguage codes from the currency localizations, comma-separated. Pass the parameter exactly once, for example langs=en,ru

No request body is passed. Other query parameters are not accepted.

Examples

curl — personal key

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/currencies/QVC/localizations?langs=en,ru" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/currencies/QVC/localizations?langs=en,ru" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/currencies/QVC/localizations?langs=en,ru', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { success, data } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/currencies/QVC/localizations?langs=en,ru', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeboolean DescriptionAlways true. The result is confirmed by a second read of the localizations

Response example

HTTP 200 OK:

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

Error response example

422 — all the specified languages are already absent:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Bitrix24 did not apply the requested currency localizations"
  }
}

Errors

HTTP Code Description
HTTP400 CodeMISSING_REQUIRED_FIELDS Descriptionlangs is missing, empty, repeated, or contains an empty language code. It is also returned if any other query parameter or a request body is passed
HTTP400 CodeINVALID_ID DescriptionThe currency code is empty after spaces are stripped
HTTP404 CodeENTITY_NOT_FOUND DescriptionA currency with the specified code is not found
HTTP422 CodeBITRIX_ERROR DescriptionAll the specified languages are already absent, Bitrix24 rejected the deletion, reported a failure, or the second read still found some of the languages
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key works in READONLY mode
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe user has no rights to perform the operation in Bitrix24
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured Bitrix24 tokens
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionA response of an unexpected structure was received
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable

Full list of common API errors — Errors.

Known specifics

The deletion is not transactional: on an error some of the languages may already be deleted. Before retrying, call Get currency localizations and pass only the remaining languages.

See also