Unregister AI Prompt ai.prompt.unregister

We are still updating this page

Some data may be missing — we will complete it shortly.

Scope: ai_admin

Who can execute the method: administrator

The method ai.prompt.unregister removes a prompt.

Parameter

Description

code*
unknown

Unique prompt code. Always has the prefix rest_. This code is set once during registration and cannot be changed afterwards

Required parameters are marked with *

Examples

// example for cURL (Webhook)

// example for cURL (OAuth)

try
        {
        	const response = await $b24.callMethod(
        		'ai.prompt.unregister',
        		{
        			code: 'rest_joke_wolf'
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'ai.prompt.unregister',
                    [
                        'code' => 'rest_joke_wolf'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error unregistering AI prompt: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'ai.prompt.unregister',
            {
                code: 'rest_joke_wolf'
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        

// example for PHP

How to Use Examples in Documentation

Success Response

Error Response

Typical use-cases and scenarios