For AI agents: markdown of this page — /docs-content-en/entities/recurring-deals/delete.md documentation index — /llms.txt

Delete recurring settings

DELETE /v1/recurring-deals/:id

Deletes settings for automatic deal repetition by ID. Deleted settings cannot be restored through the API.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber RequiredYes DescriptionSettings ID, a non-negative safe integer. Get IDs from List recurring deals

Examples

curl — personal key

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/recurring-deals/11" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/recurring-deals/11" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals/11', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
if (response.status !== 204) throw new Error(await response.text())

JavaScript — OAuth application

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals/11', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN' },
})
if (response.status !== 204) throw new Error(await response.text())

Response

A successful deletion returns HTTP status 204 No Content with an empty body. The response code is the success indicator.

Response example

http 
HTTP/1.1 204 No Content

Error response example

422 — a connected template deal exists:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Deleting is impossible. Connected recurring deal exists."
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionid is not a non-negative safe integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe settings were not found. Message: Recurring deal is not found.
HTTP422 CodeBITRIX_ERROR DescriptionA connected template deal exists. Message: Deleting is impossible. Connected recurring deal exists.
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionNo Bitrix24 access tokens are configured
HTTP403 CodeMANAGEMENT_KEY_NO_ENTITY_ACCESS DescriptionA management key has no access to entity methods
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionAfter the scope check, writing is blocked because the key is in read-only mode
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the operation or a plan restriction applies. See error.message
HTTP503 CodeBITRIX_TIMEOUT DescriptionBitrix24 did not respond in time
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionA network failure, or a Bitrix24 server error with HTTP status 500 or above
HTTP429 CodeRATE_LIMITED DescriptionThe request rate limit was exceeded. Retry after the interval in the Retry-After header

For the full list of common API errors, see Errors.

Known specifics

  • To stop automatic repetition, update the settings with active: false.
  • For the order in which to delete the template, the source deal and the generated deals, see the typical scenario.

See also