For AI agents: markdown of this page — /docs-content-en/entities/bank-details/update.md documentation index — /llms.txt

Update bank detail

PATCH /v1/bank-details/:id

Updates fields of an existing bank detail. Pass only the fields you want to change. Full list — GET /v1/bank-details/fields.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionBank detail ID

Request fields (body)

Field Type Required Description
Fieldname Typestring Requiredno DescriptionBank detail name
FieldrqBik Typestring Requiredno DescriptionBank BIC
FieldrqAccNum Typestring Requiredno DescriptionCurrent account
FieldrqCorAccNum Typestring Requiredno DescriptionCorrespondent account
FieldrqSwift Typestring Requiredno DescriptionSWIFT code
FieldrqIban Typestring Requiredno DescriptionIBAN number
FieldrqBankName Typestring Requiredno DescriptionBank name
FieldrqBankAddr Typestring Requiredno DescriptionBank address
FieldrqAccName Typestring Requiredno DescriptionAccount holder name
FieldrqAccCurrency Typestring Requiredno DescriptionAccount currency
Fieldactive Typeboolean Requiredno DescriptionWhether the detail is active
Fieldsort Typenumber Requiredno DescriptionSort order
Fieldcomments Typestring Requiredno DescriptionComment

The id, entityId, countryId, createdAt, updatedAt, createdBy, modifyBy fields are set by the system and ignored on write.

Examples

curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/bank-details/19" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rqAccName": "Acme LLC",
    "rqCorAccNum": "0123456789"
  }'

curl — OAuth application

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/bank-details/19" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "rqAccName": "Acme LLC",
    "rqCorAccNum": "0123456789"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details/19', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    rqAccName: 'Acme LLC',
    rqCorAccNum: '0123456789',
  }),
})

const { success, data } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details/19', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    rqAccName: 'Acme LLC',
    rqCorAccNum: '0123456789',
  }),
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe updated bank detail with current field values
Fielddata.id Typenumber DescriptionRecord ID
Fielddata.entityId Typenumber DescriptionID of the owner requisite
Fielddata.updatedAt Typedatetime DescriptionNew modification date (ISO 8601)
Fielddata.modifyBy Typenumber DescriptionID of the user who performed the update

The object contains all fields in camelCase, including unchanged ones. Unset fields are null. Full list — Bank detail fields.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 19,
    "entityId": 1,
    "countryId": 0,
    "createdAt": "2026-06-10T10:14:29.000Z",
    "updatedAt": "2026-06-10T10:14:31.000Z",
    "createdBy": 1,
    "modifyBy": 1,
    "name": "Current account",
    "code": null,
    "xmlId": null,
    "originatorId": null,
    "active": true,
    "sort": 500,
    "rqBankName": "First National Bank",
    "rqBankAddr": null,
    "rqBik": null,
    "rqAccName": "Acme LLC",
    "rqAccNum": "1234567890",
    "rqAccCurrency": null,
    "rqCorAccNum": "0123456789",
    "rqIban": null,
    "rqSwift": "CHASUS33",
    "comments": null
  }
}

Error response example

404 — bank detail not found:

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

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo bank detail with this ID found
HTTP403 CodeSCOPE_DENIED DescriptionKey lacks the crm scope. Message: This endpoint requires 'crm' scope
HTTP401 CodeTOKEN_MISSING DescriptionX-Api-Key not provided

Full list of common API errors — Errors.

Known specifics

An empty value clears the field. To clear a field, pass an empty string "". This works only for the STRING fields — name, code, xmlId, originatorId, comments and the rq* fields. For the numeric fields (entityTypeId, entityId, countryId, sort) and the boolean active, an empty string does not clear the value — it is refused with 400 INVALID_PARAMS as a type mismatch: send null, or omit the field instead. In the response, cleared strings come back as null.

See also