Delete a set of additional content blocks for the timeline record crm.timeline.layout.blocks.delete

Scope: crm

Who can execute the method: administrator

The method crm.timeline.layout.blocks.delete removes a set of additional content blocks for a timeline record.

Within the application, you can only delete the set of additional content blocks that was installed through this application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
entityTypeId* `integer`	Identifier of the entity type to which the timeline record is linked
entityId* `integer`	Identifier of the entity to which the timeline record is linked
timelineId* `integer`	Identifier of the timeline record

Code Examples

Delete a set of additional content blocks for the timeline record with id = 8, linked to the deal with id = 4:

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"entityId":4,"timelineId":8}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.layout.blocks.delete

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"entityId":4,"timelineId":8,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.timeline.layout.blocks.delete

try
        {
        	const response = await $b24.callMethod(
        		'crm.timeline.layout.blocks.delete',
        		{
        			entityTypeId: 2, // Deal
        			entityId: 4,     // Deal ID
        			timelineId: 8,   // ID of the timeline record linked to this deal
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.timeline.layout.blocks.delete',
                    [
                        'entityTypeId' => 2, // Deal
                        'entityId'     => 4, // Deal ID
                        'timelineId'   => 8, // ID of the timeline record linked to this deal
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error deleting timeline layout block: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.timeline.layout.blocks.delete',
            {
                entityTypeId: 2, // Deal
                entityId: 4,     // Deal ID
                timelineId: 8,   // ID of the timeline record linked to this deal
            },
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            },
        );

require_once('crest.php');
        $result = CRest::call(
            'crm.timeline.layout.blocks.delete',
            [
                'entityTypeId' => 2,
                'entityId' => 4,
                'timelineId' => 8,
            ]
        );
        echo '';
        print_r($result);
        echo '';

Response Handling

HTTP status: 200

Returns { success: true } if the set of additional content blocks was successfully deleted, otherwise null.

{
            "success": true
        }

Error Handling

HTTP status: 400

{
            "error": "ERROR_WRONG_CONTEXT",
            "error_description": "The method can only be called in the context of a rest application"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`ERROR_WRONG_CONTEXT`	The method can only be called in the context of a rest application
`OWNER_NOT_FOUND`	The element to which the timeline record is linked was not found
`NOT_FOUND`	The timeline record or the set of additional content blocks was not found
`ACCESS_DENIED`	Access denied

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Retrieve a Set of Additional Content Blocks

Example Application with Additional Content Blocks

Delete a set of additional content blocks for the timeline record crm.timeline.layout.blocks.delete

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning