Dành cho AI agent: markdown của trang này — /docs-content-en/sign-b2e/update-provider.md chỉ mục tài liệu — /llms.txt

Hiện tại, các bài viết trong tài liệu chỉ có bằng tiếng Anh.

Update an external provider

PATCH /v1/sign-b2e/providers/:id

Updates an external signature provider. Requires administrator OAuth. An omitted field or null keeps the previous value.

Scopes: sign.b2e.

Available only to an OAuth application key with a user session. A personal key receives 422 BITRIX_ERROR with the native WRONG_AUTH_TYPE code in error.b24Code, so the examples below cover the OAuth application only.

Path parameters

Parameter Type Required Description
Parameterid Typestring Requiredyes DescriptionNumeric external provider ID from List providers.

Request body fields

Parameter Type Required Description
Parameterfields Typeobject Requiredyes DescriptionExternal provider fields. Values are passed to Bitrix24.
Parameterfields.title Typestring | null Requiredno DescriptionProvider name. null or an omitted field keeps the previous value.
Parameterfields.description Typestring | null Requiredno DescriptionProvider description. null or an omitted field keeps the previous value.
Parameterfields.iconUri Typestring | null Requiredno DescriptionProvider icon URL. null or an omitted field keeps the previous value.
Parameterfields.companyRegUri Typestring | null Requiredno DescriptionCompany registration URL. null or an omitted field keeps the previous value.
Parameterfields.documentSignUri Typestring | null Requiredno DescriptionDocument signing URL. null or an omitted field keeps the previous value.
Parameterfields.publicKeyUri Typestring | null Requiredno DescriptionProvider public key URL. null or an omitted field keeps the previous value.

Examples

curl — OAuth application

Terminal
curl -X PATCH 'https://vibecode.bitrix24.com/v1/sign-b2e/providers/7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"fields": {"title": "VIBE-PROBE updated"}}'

JavaScript — OAuth application

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/providers/7', {
  "method": "PATCH",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"fields": {"title": "VIBE-PROBE updated"}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionWhether the request succeeded.
Fielddata Typeobject DescriptionOperation data.
Fielddata.updated Typeboolean DescriptionProvider update result.
Fieldmeta.redacted Typearray DescriptionPresent when credentials are hidden; contains the paths of the replaced values.

Response example

Shape of a successful response; the data depends on the Bitrix24 account and the request.

JSON
{
  "success": true,
  "data": {
    "updated": true
  }
}

Error response example

422 — request with a personal key:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Current authorization type is denied for this method Application context required",
    "b24Code": "WRONG_AUTH_TYPE"
  }
}

Errors

HTTP Code Reason
HTTP400 CodeINVALID_PARAMS ReasonInvalid request shape: types, required fields or an unknown query string parameter.
HTTP401 CodeTOKEN_MISSING ReasonNo credentials for the Bitrix24 connection.
HTTP403 CodeSCOPE_DENIED ReasonOne of the required scopes is not granted.
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY ReasonThe key is read-only.
HTTP422 CodeBITRIX_ERROR ReasonRequest with a personal key: the method is available to OAuth applications only. error.b24Code is WRONG_AUTH_TYPE.
HTTP422 CodeBITRIX_ERROR ReasonAny other Bitrix24 rejection. The code is in error.b24Code, the text in error.message.

Common API errors.

Known specifics

Bitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.

The operation is not retried automatically. If the outcome is unknown, check the state in the Bitrix24 account first; repeating the call can repeat the operation.

See also