Update Configurable Activity crm.activity.configurable.update

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: any user

The crm.activity.configurable.update method modifies a configurable activity.

Warning

The method can only be called within the context of the application that created it.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Integer identifier of the activity, for example `999`
fields* `array`	Associative array of values for activity fields in the following structure: `fields: { "typeId": 'value', "completed": 'value', "deadline": 'value', "pingOffsets": 'value', "isIncomingChannel": 'value', "responsibleId": 'value', "badgeCode": 'value', "originatorId": 'value', "originId": 'value', }`
layout* `LayoutDto`	A special structure associative array describing the appearance of the activity in the timeline

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

Python

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"fields":{"typeId":"CONFIGURABLE","completed":false,"deadline":"**put_current_date_time_here**","pingOffsets":[300],"isIncomingChannel":"Y","responsibleId":5,"badgeCode":"CUSTOM"},"layout":{"icon":{"code":"call-completed"},"header":{"title":"Incoming call"},"body":{"logo":{"code":"call-incoming"},"blocks":{"responsible":{"type":"lineOfBlocks","properties":{"blocks":{"client":{"type":"link","properties":{"text":"Klaus Weber","bold":true,"action":{"type":"redirect","uri":"/crm/lead/details/789/"}}},"phone":{"type":"text","properties":{"value":"+49 999 888 7777"}}}}}}},"footer":{"buttons":{"startCall":{"title":"About the client","action":{"type":"openRestApp","actionParams":{"clientId":456}},"type":"primary"}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.configurable.update

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ActivityUpdateResult = {
  activity: {
    id: number
  }
}

try {
  const response = await $b24.actions.v2.call.make<ActivityUpdateResult>({
    method: 'crm.activity.configurable.update',
    params: {
      id: 999,
      fields: {
        typeId: 'CONFIGURABLE',
        completed: false,
        deadline: '2025-08-01T12:00:00+02:00',
        pingOffsets: [300],
        isIncomingChannel: 'Y',
        responsibleId: 5,
        badgeCode: 'CUSTOM',
      },
      layout: {
        icon: {
          code: 'call-completed',
        },
        header: {
          title: 'Incoming call',
        },
        body: {
          logo: {
            code: 'call-incoming',
          },
          blocks: {
            responsible: {
              type: 'lineOfBlocks',
              properties: {
                blocks: {
                  client: {
                    type: 'link',
                    properties: {
                      text: 'John Smith',
                      bold: true,
                      action: {
                        type: 'redirect',
                        uri: '/crm/lead/details/789/',
                      },
                    },
                  },
                  phone: {
                    type: 'text',
                    properties: {
                      value: '+49 999 888 7777',
                    },
                  },
                },
              },
            },
          },
        },
        footer: {
          buttons: {
            startCall: {
              title: 'About client',
              action: {
                type: 'openRestApp',
                actionParams: {
                  clientId: 456,
                },
              },
              type: 'primary',
            },
          },
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Updated activity id:', result.activity.id)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateConfigurableActivity() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.configurable.update',
        params: {
          id: 999,
          fields: {
            typeId: 'CONFIGURABLE',
            completed: false,
            deadline: '2025-08-01T12:00:00+02:00',
            pingOffsets: [300],
            isIncomingChannel: 'Y',
            responsibleId: 5,
            badgeCode: 'CUSTOM',
          },
          layout: {
            icon: {
              code: 'call-completed',
            },
            header: {
              title: 'Incoming call',
            },
            body: {
              logo: {
                code: 'call-incoming',
              },
              blocks: {
                responsible: {
                  type: 'lineOfBlocks',
                  properties: {
                    blocks: {
                      client: {
                        type: 'link',
                        properties: {
                          text: 'John Smith',
                          bold: true,
                          action: {
                            type: 'redirect',
                            uri: '/crm/lead/details/789/',
                          },
                        },
                      },
                      phone: {
                        type: 'text',
                        properties: {
                          value: '+49 999 888 7777',
                        },
                      },
                    },
                  },
                },
              },
            },
            footer: {
              buttons: {
                startCall: {
                  title: 'About client',
                  action: {
                    type: 'openRestApp',
                    actionParams: {
                      clientId: 456,
                    },
                  },
                  type: 'primary',
                },
              },
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Updated activity id:', result.activity.id)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateConfigurableActivity)
</script>

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.activity.configurable.update',
            [
                'id'     => 999,
                'fields' => [
                    'typeId'            => 'CONFIGURABLE',
                    'completed'         => false,
                    'deadline'          => new DateTime(),
                    'pingOffsets'       => [300],
                    'isIncomingChannel' => 'Y',
                    'responsibleId'     => 5,
                    'badgeCode'         => 'CUSTOM',
                ],
                'layout' => [
                    'icon'   => [
                        'code' => 'call-completed',
                    ],
                    'header' => [
                        'title' => 'Incoming call',
                    ],
                    'body'   => [
                        'logo'   => [
                            'code' => 'call-incoming',
                        ],
                        'blocks' => [
                            'responsible' => [
                                'type'       => 'lineOfBlocks',
                                'properties' => [
                                    'blocks' => [
                                        'client' => [
                                            'type'       => 'link',
                                            'properties' => [
                                                'text'   => 'Klaus Weber',
                                                'bold'   => true,
                                                'action' => [
                                                    'type' => 'redirect',
                                                    'uri'  => '/crm/lead/details/789/',
                                                ],
                                            ],
                                        ],
                                        'phone'  => [
                                            'type'       => 'text',
                                            'properties' => [
                                                'value' => '+49 999 888 7777',
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                    'footer' => [
                        'buttons' => [
                            'startCall' => [
                                'title'  => 'About the client',
                                'action' => [
                                    'type'         => 'openRestApp',
                                    'actionParams' => [
                                        'clientId' => 456,
                                    ],
                                ],
                                'type'   => 'primary',
                            ],
                        ],
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // The data processing logic you need
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating configurable activity: ' . $e->getMessage();
}

BX24.callMethod(
    "crm.activity.configurable.update",
    {
        id: 999,
        fields:
        {
            typeId: 'CONFIGURABLE',
            completed: false,
            deadline: new Date(),
            pingOffsets: [300],
            isIncomingChannel: 'Y',
            responsibleId: 5,
            badgeCode: 'CUSTOM',
        },
        layout:
        {
            "icon": {
                "code": "call-completed"
            },
            "header": {
                "title": "Incoming call"
            },
            "body": {
                "logo": {
                    "code": "call-incoming"
                },
                "blocks": {
                    "responsible": {
                        "type": "lineOfBlocks",
                        "properties": {
                            "blocks": {
                                "client": {
                                    "type": "link",
                                    "properties": {
                                        "text": "Klaus Weber",
                                        "bold": true,
                                        "action": {
                                            "type": "redirect",
                                            "uri": "/crm/lead/details/789/"
                                        }
                                    }
                                },
                                "phone": {
                                    "type": "text",
                                    "properties": {
                                        "value": "+49 999 888 7777"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "footer": {
                "buttons": {
                    "startCall": {
                        "title": "About the client",
                        "action": {
                            "type": "openRestApp",
                            "actionParams": {
                                "clientId": 456
                            }
                        },
                        "type": "primary"
                    }
                }
            }
        }
    }, result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }    
);

require_once('crest.php');

$result = CRest::call(
    'crm.activity.configurable.update',
    [
        'id' => 999,
        'fields' => [
            'typeId' => 'CONFIGURABLE',
            'completed' => false,
            'deadline' => date('c'), // We use the current date and time in ISO 8601 format
            'pingOffsets' => [300],
            'isIncomingChannel' => 'Y',
            'responsibleId' => 5,
            'badgeCode' => 'CUSTOM',
        ],
        'layout' => [
            'icon' => [
                'code' => 'call-completed'
            ],
            'header' => [
                'title' => 'Incoming call'
            ],
            'body' => [
                'logo' => [
                    'code' => 'call-incoming'
                ],
                'blocks' => [
                    'responsible' => [
                        'type' => 'lineOfBlocks',
                        'properties' => [
                            'blocks' => [
                                'client' => [
                                    'type' => 'link',
                                    'properties' => [
                                        'text' => 'Klaus Weber',
                                        'bold' => true,
                                        'action' => [
                                            'type' => 'redirect',
                                            'uri' => '/crm/lead/details/789/'
                                        ]
                                    ]
                                ],
                                'phone' => [
                                    'type' => 'text',
                                    'properties' => [
                                        'value' => '+49 999 888 7777'
                                    ]
                                ]
                            ]
                        ]
                    ]
                ]
            ],
            'footer' => [
                'buttons' => [
                    'startCall' => [
                        'title' => 'About the client',
                        'action' => [
                            'type' => 'openRestApp',
                            'actionParams' => [
                                'clientId' => 456
                            ]
                        ],
                        'type' => 'primary'
                    ]
                ]
            ]
        ]
    ]
);

if (isset($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    echo '<PRE>';
    print_r($result['result']);
    echo '</PRE>';
}

Example

from datetime import datetime, timedelta

from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

client: BaseClient

try:
    bitrix_response = client.crm.activity.configurable.update(
        bitrix_id=999,
        fields={
            "completed": True,
            "deadline": (datetime.now() + timedelta(days=1)).isoformat(timespec="seconds"),
            "pingOffsets": [30],
            "responsibleId": 1,
            "badgeCode": "CUSTOM_STATUS",
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Bitrix API error",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Bitrix SDK error: {error.message}")
except Exception as error:
    print(f"Unexpected error: {error}")

// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.activity.configurable.update", b24.Params{
	"id": 999,
	"fields": b24.Params{
		"typeId":            "CONFIGURABLE",
		"completed":         false,
		"deadline":          "**put_current_date_time_here**",
		"pingOffsets":       []int{300},
		"isIncomingChannel": "Y",
		"responsibleId":     5,
		"badgeCode":         "CUSTOM",
	},
	"layout": b24.Params{
		"icon": b24.Params{
			"code": "call-completed",
		},
		"header": b24.Params{
			"title": "Incoming call",
		},
		"body": b24.Params{
			"logo": b24.Params{
				"code": "call-incoming",
			},
			"blocks": b24.Params{
				"responsible": b24.Params{
					"type": "lineOfBlocks",
					"properties": b24.Params{
						"blocks": b24.Params{
							"client": b24.Params{
								"type": "link",
								"properties": b24.Params{
									"text": "Klaus Weber",
									"bold": true,
									"action": b24.Params{
										"type": "redirect",
										"uri":  "/crm/lead/details/789/",
									},
								},
							},
							"phone": b24.Params{
								"type": "text",
								"properties": b24.Params{
									"value": "+49 999 888 7777",
								},
							},
						},
					},
				},
			},
		},
		"footer": b24.Params{
			"buttons": b24.Params{
				"startCall": b24.Params{
					"title": "About the client",
					"action": b24.Params{
						"type": "openRestApp",
						"actionParams": b24.Params{
							"clientId": 456,
						},
					},
					"type": "primary",
				},
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.activity.configurable.update: %w", err)
}

// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)

Response Handling

HTTP status: 200

{
    "result": {
        "activity": {
            "id": 999,
        },
    "time": {
        "start": 1724068028.331234,
        "finish": 1724068028.726591,
        "duration": 0.3953571319580078,
        "processing": 0.13033390045166016,
        "date_start": "2025-01-21T13:47:08+02:00",
        "date_finish": "2025-01-21T13:47:08+02:00",
        "operating": 0
        }
    }
}

Returned Data

Name `type`	Description
result `object`	Response root element containing the activity identifier `id` information in case of success. In case of failure, it will return `null`
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
    "error": "NOT_FOUND",
    "error_description": "Not found."
}

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
`ACCESS_DENIED`	Insufficient permissions to perform the operation
`NOT_FOUND`	Element not found
`100`	Required fields are not filled
`ERROR_WRONG_CONTEXT`	Method call is only possible in the context of an application
`ERROR_WRONG_APPLICATION`	The activity can only be updated by the application that created it
`WRONG_FIELD_VALUE`	Incorrect field value
`INCOMING_ACTIVITY_CAN_NOT_BE_WITH_DEADLINE`	Incoming activity cannot have a deadline
`ERROR_EMPTY_LAYOUT`	The layout field must be filled
`FIELD_IS_REQUIRED`	A required field was not passed in the structure object
`FIELD_IS_REDUNDANT`	A field was passed in the structure object that is not in its description
`ENUM_FIELD`	The field value is not in the list of allowed values, for example, an unknown tag type
`TOO_MANY_ITEMS`	The number of array elements has been exceeded, for example, more than two tags or buttons
`KEY_CONTAIN_WRONG_SYMBOLS`	The key in the structure's associative array contains invalid characters. Only Latin letters, digits, hyphens, and underscores are allowed
`WRONG_LANG`	In the multi-language value, a language code was passed that is not set on the portal

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Add Configurable Activity

Get Information about Configurable Activity

Update Configurable Activity crm.activity.configurable.update

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning