Update a Signing Provider sign.b2e.provider.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sign.b2e

Who can execute the method: administrator

The method sign.b2e.provider.update updates the data of an external signing provider.

The method works only in the context of the application authorization.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Provider identifier.

The identifier is returned by the sign.b2e.provider.add method, and the list of providers with identifiers is returned by the sign.b2e.provider.tail method. A deleted provider cannot be updated

fields*
object

Object with the provider fields to update. Pass only the fields you want to change: a field that is omitted or passed as null stays unchanged. Field description

Parameter fields

Pass full addresses with the http or https scheme. A required field cannot be cleared with an empty string — the service returns the The field ... is required. error.

Name
type

Description

title
string

Provider name

description
string

Short description of the provider

iconUri
string

Address of the provider icon for the Bitrix24 interface

companyRegUri
string

Address of the page where a company registers with the provider

documentSignUri
string

Address of the provider's document signing page

publicKeyUri
string

Address of the provider's public key. The key is used to verify document signatures

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":42,"fields":{"description":"Updated text about provider","publicKeyUri":"https://provider.sign.com/bitrix/public-2026.key"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sign.b2e.provider.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
        
        // On a sign service failure result holds error and error_description instead of true
        type ProviderUpdateResult = boolean | { error: number, error_description: string }
        
        try {
          const response = await $b24.actions.v2.call.make<ProviderUpdateResult>({
            method: 'sign.b2e.provider.update',
            params: {
              id: 42,
              fields: {
                description: 'Updated text about provider',
                publicKeyUri: 'https://provider.sign.com/bitrix/public-2026.key',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            if (typeof result === 'object') {
              console.error(result.error_description)
            } else {
              console.info('Provider updated')
            }
          }
        } 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 updateSignProvider() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sign.b2e.provider.update',
                params: {
                  id: 42,
                  fields: {
                    description: 'Updated text about provider',
                    publicKeyUri: 'https://provider.sign.com/bitrix/public-2026.key'
                  }
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              // On a sign service failure result holds error and error_description instead of true
              const result = response.getData().result
              if (typeof result === 'object') {
                console.error(result.error_description)
              } else {
                console.info('Provider updated')
              }
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSignProvider)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.call(
                "sign.b2e.provider.update",
                {
                    "id": 42,
                    "fields": {
                        "description": "Updated text about provider",
                        "publicKeyUri": "https://provider.sign.com/bitrix/public-2026.key",
                    },
                },
            ).response
            result = bitrix_response.result
            # On a sign service failure result holds error and error_description
            if isinstance(result, dict):
                print(f"Sign service error: {result['error_description']}")
            else:
                print("Provider updated")
        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}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sign.b2e.provider.update',
                    [
                        'id' => 42,
                        'fields' => [
                            'description' => 'Updated text about provider',
                            'publicKeyUri' => 'https://provider.sign.com/bitrix/public-2026.key'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sign.b2e.provider.update',
            {
                id: 42,
                fields: {
                    description: 'Updated text about provider',
                    publicKeyUri: 'https://provider.sign.com/bitrix/public-2026.key'
                }
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sign.b2e.provider.update',
            [
                'id' => 42,
                'fields' => [
                    'description' => 'Updated text about provider',
                    'publicKeyUri' => 'https://provider.sign.com/bitrix/public-2026.key'
                ]
            ]
        );
        
        if (isset($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } elseif (is_array($result['result'])) {
            echo 'Sign service error: ' . $result['result']['error_description'];
        } else {
            echo 'Provider updated';
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sign.b2e.provider.update", b24.Params{
        	"id": 42,
        	"fields": b24.Params{
        		"description":  "Updated text about provider",
        		"publicKeyUri": "https://provider.sign.com/bitrix/public-2026.key",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sign.b2e.provider.update: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	// on a sign service failure result holds error and error_description
        	return fmt.Errorf("sign service response: %s", res.Result)
        }
        fmt.Println("provider updated:", ok)
        

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1792738606,
                "finish": 1792738606.449847,
                "duration": 0.4498469829559326,
                "processing": 0,
                "date_start": "2026-10-23T09:56:46+03:00",
                "date_finish": "2026-10-23T09:56:46+03:00",
                "operating_reset_at": 1792739160,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Update result. true means the provider data has been updated

time
time

Information about the request execution time

Error Handling

HTTP Status: 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Current authorization type is denied for this method Application context required"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Errors of the Bitrix24 sign service are returned with HTTP status 200 in one of two forms.

If an error has a code, the response contains error and error_description at the top level, like a regular method error. Address validation errors and the "provider not found" error are returned this way:

{
            "error": 510,
            "error_description": "External provider with id 42 and clientId 7 doesnt exist",
            "ex": {
                "status": 200,
                "ex": 510
            }
        }
        

If an error has no code, result contains an object with the error and error_description fields instead of true. Consider the call successful only if result equals true:

{
            "result": {
                "error": 0,
                "error_description": "The field Icon URL is required."
            },
            "time": {
                "start": 1792738606,
                "finish": 1792738606.449847,
                "duration": 0.4498469829559326,
                "processing": 0,
                "date_start": "2026-10-23T09:56:46+03:00",
                "date_finish": "2026-10-23T09:56:46+03:00",
                "operating_reset_at": 1792739160,
                "operating": 0
            }
        }
        

If the error text contains the code SIGN_CLIENT_CONNECTION_ERROR, INCORRECT_JSON, INCORRECT_HTTP_STATUS, INCORRECT_DATA, or INCORRECT_REGISTER_RESPONSE, Bitrix24 did not receive a response from the service. The changes may have been saved anyway. You can check the provider data with the sign.b2e.provider.tail method.

Possible Error Codes

Status

Code

Description

Value

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

The method was called outside an application with OAuth authorization, for example, through a webhook

403

ACCESS_DENIED

Access denied! Access denied

The user is not an administrator, or e-Signature for HR is not available on Bitrix24

403

ACCESS_DENIED

Access denied! User authorization required

The request was made without user authorization

200

510

External provider with id #ID# and clientId #CLIENT_ID# doesnt exist

The provider with the id identifier was not found or has been deleted

200

100

IconUri must be empty or valid

The iconUri field contains an address without the http or https scheme

200

100

CompanyRegUri must be empty or valid

The companyRegUri field contains an address without the http or https scheme

200

100

DocumentSignUri must be empty or valid

The documentSignUri field contains an address without the http or https scheme

200

100

PublicKeyUri must be empty or valid

The publicKeyUri field contains an address without the http or https scheme

200

0 in result.error

The field #FIELD# is required.

An empty string was passed to a required field. #FIELD# is replaced with the field name, for example, Icon URL

200

0 in result.error

Cannot perform action. Please try again later (error code: #CODE#).

The sign service returned an error, or Bitrix24 did not receive its response. #CODE# is replaced with the code of the cause. The text is returned in the user's language

200

0 in result.error

This action is not available yet, please try again later.

The sign service version does not support this action yet

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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