For AI agents: markdown of this page — /docs-content-en/entities/requisite-links/unregister.md documentation index — /llms.txt

Delete a requisite link

DELETE /v1/requisite-links/:entityTypeId/:entityId

Deletes the link between a requisite and an entity. After deletion the requisite and the bank detail remain in the system — only the link between them and the owner entity is removed.

Parameters

Parameter Type Required Description
ParameterentityTypeId (path) Typenumber Requiredyes DescriptionLink owner type. Values — Link fields
ParameterentityId (path) Typenumber Requiredyes DescriptionOwner entity ID

Examples

curl — personal key

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/requisite-links/2/3825" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/requisite-links/2/3825" \
  -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/requisite-links/2/3825', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Deleted link for entityId:', data.entityId)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-links/2/3825', {
  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 Typeobject DescriptionDeletion result
Fielddata.entityTypeId Typenumber DescriptionEntity type from the request path
Fielddata.entityId Typenumber DescriptionEntity ID from the request path
Fielddata.unregistered Typeboolean DescriptionAlways true on success

Response example

HTTP status: 200 OK

JSON 
{
  "success": true,
  "data": {
    "entityTypeId": 2,
    "entityId": 3825,
    "unregistered": true
  }
}

Error response example

400 — invalid entityTypeId or entityId in the path:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_ANCHOR",
    "message": "Path requires entityTypeId and entityId — both positive integers (e.g. /v1/requisite-links/31/42)"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_ANCHOR DescriptionentityTypeId or entityId in the path is not a positive integer
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope. Message: This endpoint requires 'crm' scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — Errors.

Known specifics

Idempotent. Deletion returns 200 {unregistered: true} even if no link existed for the (entityTypeId, entityId) pair — a repeat call is safe, and there is no separate "not found" error.

See also