Add Forum Message Custom Field forum.message.field.custom.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"UF_EXTERNAL_ID","userTypeId":"string","xmlId":"EXTERNAL_ID","sort":200,"isMandatory":false,"isSearchable":true,"editFormLabel":{"de":"Externe ID","en":"External ID"},"helpMessage":{"de":"Nachrichtencode im externen System","en":"Message code in the external system"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.add
        

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CustomFieldAddResult = {
          item: {
            id: number
            entityId: string
            name: string
            userTypeId: string
            xmlId: string | null
            sort: number
            isMultiple: boolean
            isMandatory: boolean
            showFilter: string
            showInList: boolean
            editInList: boolean
            isSearchable: boolean
            settings: Record<string, unknown>
            editFormLabel: string | null
            listColumnLabel: string | null
            listFilterLabel: string | null
            errorMessage: string | null
            helpMessage: string | null
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<CustomFieldAddResult>({
            method: 'forum.message.field.custom.add',
            params: {
              fields: {
                name: 'UF_EXTERNAL_ID',
                userTypeId: 'string',
                xmlId: 'EXTERNAL_ID',
                sort: 200,
                isMandatory: false,
                isSearchable: true,
                editFormLabel: { de: 'Externe ID', en: 'External ID' },
                helpMessage: { de: 'Nachrichtencode im externen System', en: 'Message code in the external system' },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Custom field created:', result.item.id)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addCustomField() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'forum.message.field.custom.add',
                params: {
                  fields: {
                    name: 'UF_EXTERNAL_ID',
                    userTypeId: 'string',
                    xmlId: 'EXTERNAL_ID',
                    sort: 200,
                    isMandatory: false,
                    isSearchable: true,
                    editFormLabel: { de: 'Externe ID', en: 'External ID' },
                    helpMessage: { de: 'Nachrichtencode im externen System', en: 'Message code in the external system' },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Custom field created:', result.item.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addCustomField)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.forum.message.field.custom.add(
                fields={
                    "name": "UF_EXTERNAL_ID",
                    "userTypeId": "string",
                    "xmlId": "EXTERNAL_ID",
                    "sort": 200,
                    "isMandatory": False,
                    "isSearchable": True,
                    "editFormLabel": {"de": "Externe ID", "en": "External ID"},
                    "helpMessage": {"de": "Nachrichtencode im externen System", "en": "Message code in the external system"},
                },
            ).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}")
        

try {
            $response = $b24Service
                ->core
                ->call(
                    'forum.message.field.custom.add',
                    [
                        'fields' => [
                            'name' => 'UF_EXTERNAL_ID',
                            'userTypeId' => 'string',
                            'xmlId' => 'EXTERNAL_ID',
                            'sort' => 200,
                            'isMandatory' => false,
                            'isSearchable' => true,
                            'editFormLabel' => ['de' => 'Externe ID', 'en' => 'External ID'],
                            'helpMessage' => ['de' => 'Nachrichtencode im externen System', 'en' => 'Message code in the external system'],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'forum.message.field.custom.add',
            {
                fields: {
                    name: 'UF_EXTERNAL_ID',
                    userTypeId: 'string',
                    xmlId: 'EXTERNAL_ID',
                    sort: 200,
                    isMandatory: false,
                    isSearchable: true,
                    editFormLabel: { de: 'Externe ID', en: 'External ID' },
                    helpMessage: { de: 'Nachrichtencode im externen System', en: 'Message code in the external system' },
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'forum.message.field.custom.add',
            [
                'fields' => [
                    'name' => 'UF_EXTERNAL_ID',
                    'userTypeId' => 'string',
                    'xmlId' => 'EXTERNAL_ID',
                    'sort' => 200,
                    'isMandatory' => false,
                    'isSearchable' => true,
                    'editFormLabel' => ['de' => 'Externe ID', 'en' => 'External ID'],
                    'helpMessage' => ['de' => 'Nachrichtencode im externen System', 'en' => 'Message code in the external system'],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "forum.message.field.custom.add", b24.Params{
        	"fields": b24.Params{
        		"name":          "UF_EXTERNAL_ID",
        		"userTypeId":    "string",
        		"xmlId":         "EXTERNAL_ID",
        		"sort":          200,
        		"isMandatory":   false,
        		"isSearchable":  true,
        		"editFormLabel": b24.Params{"de": "Externe ID", "en": "External ID"},
        		"helpMessage":   b24.Params{"de": "Nachrichtencode im externen System", "en": "Message code in the external system"},
        	},
        })
        if err != nil {
        	return fmt.Errorf("forum.message.field.custom.add: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        var item struct {
        	ID            int     `json:"id"`
        	Name          string  `json:"name"`
        	UserTypeID    string  `json:"userTypeId"`
        	EditFormLabel *string `json:"editFormLabel"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.UserTypeID)