Create a new deal crm.deal.add

Scope: crm

Who can execute the method: any user with the "add" access permission for deals

Method Development Stopped

The method crm.deal.add continues to function, but there is a more relevant alternative crm.item.add.

The method crm.deal.add creates a new deal.

Method Parameters

Name
type

Description

fields
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — field name
value_n — field value

The list of available fields is described below

params
object

Object containing an additional set of parameters (detailed description)

Parameter fields

Name `type`	Description
TITLE `string`	Deal title. By default, it is generated using the template `Deal #{id}`, where `id` is the element identifier
TYPE_ID `crm_status`	String identifier of the deal type. The list of available deal types can be obtained using the method crm.status.list with the filter `{ ENTITY_ID: 'DEAL_TYPE' }`. By default — the first available deal type
CATEGORY_ID `crm_category`	Identifier of the funnel. Must be greater than or equal to 0. The list of available funnels can be obtained using the method crm.category.list by passing `entityTypeId = 2`. By default — the identifier of the default funnel
STAGE_ID `crm_status`	Stage of the deal. The list of available stages can be obtained using the method crm.status.list with the filter: `{ ENTITY_ID: "DEAL_STAGE" }` — if the deal is in the general funnel (direction) `{ ENTITY_ID: "DEAL_STAGE_{categoryId}" }` — if the deal is not in the general funnel, where `categoryId` is the identifier of the deal funnel By default — the first available stage relative to the funnel
IS_RECURRING `char`	Is the deal a template for a recurring deal? Possible values: `Y` — yes `N` — no By default `N`
IS_RETURN_CUSTOMER `char`	Is the deal a repeat? Possible values: `Y` — yes `N` — no By default `N`
IS_REPEATED_APPROACH `char`	Is the deal a repeated approach? Possible values: `Y` — yes `N` — no By default `N`
PROBABILITY `integer`	Probability, %
CURRENCY_ID `crm_currency`	Currency. The list of available currencies can be obtained using the method crm.currency.list
OPPORTUNITY `double`	Amount. By default `0.00`
IS_MANUAL_OPPORTUNITY `char`	Is manual calculation of the amount enabled? Possible values: `Y` — yes `N` — no By default `N`
TAX_VALUE `double`	Tax amount. By default `0.00`
COMPANY_ID `crm_company`	Identifier of the company associated with the deal. The list of companies can be obtained using the method crm.item.list by passing `entityTypeId = 4`
CONTACT_ID `crm_contact`	Contact. Deprecated
CONTACT_IDS `crm_contact[]`	List of contacts associated with the deal. The list of contacts can be obtained using the method crm.item.list by passing `entityTypeId = 3`
BEGINDATE `date`	Start date. By default — the date of deal creation
CLOSEDATE `date`	Completion date. By default — the date of deal creation plus 7 days
OPENED `char`	Is the deal available to everyone? Possible values: `Y` — yes `N` — no By default `Y`. The default value can be changed in CRM settings
CLOSED `char`	Is the deal closed? Possible values: `Y` — yes `N` — no By default `N`
COMMENTS `string`	Comment. Supports bb-codes
ASSIGNED_BY_ID `user`	Responsible person. By default — the user calling this method
SOURCE_ID `crm_status`	String identifier of the source type. The list of available sources can be obtained using the method crm.status.list with the filter `{ ENTITY_ID: "SOURCE" }`. By default — the first available source type
SOURCE_DESCRIPTION `string`	Additional information about the source
ADDITIONAL_INFO `string`	Additional information
LOCATION_ID `location`	Client's location. System field
ORIGINATOR_ID `string`	Identifier of the data source. Used only for linking to an external source
ORIGIN_ID `string`	Identifier of the element in the data source. Used only for linking to an external source
UTM_SOURCE `string`	Advertising system (Google-Adwords and others)
UTM_MEDIUM `string`	Type of traffic. Possible values: `CPC` — ads `CPM` — banners
UTM_CAMPAIGN `string`	Designation of the advertising campaign
UTM_CONTENT `string`	Content of the campaign. For example, for contextual ads
UTM_TERM `string`	Search term of the campaign. For example, keywords for contextual advertising
TRACE `string`	Information for Sales Intelligence — read more in the article How to Transfer Information to Sales Intelligence
UF_CRM_...	Custom fields. For example, `UF_CRM_25534736`. Depending on the portal settings, deals may have a set of custom fields of specific types. You can add a custom field to a deal using the method crm.deal.userfield.add
PARENT_ID_... `crm_entity`	Relationship fields. If there are SPAs related to deals on the portal, there is a field for each such SPA that stores the relationship between this SPA and the deal. The field itself stores the identifier of the element of that SPA. For example, the field `PARENT_ID_153` — relationship with the SPA `entityTypeId=153`, stores the identifier of the element of this SPA related to the current deal

Parameter params

Name
type

Description

REGISTER_SONET_EVENT
boolean

Should the event of adding a deal be registered in the live feed? Possible values:

Y — yes
N — no

By default Y

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FIELDS":{"TITLE":"New Deal #1","TYPE_ID":"COMPLEX","CATEGORY_ID":0,"STAGE_ID":"PREPARATION","IS_RECURRING":"N","IS_RETURN_CUSTOMER":"Y","IS_REPEATED_APPROACH":"Y","PROBABILITY":99,"CURRENCY_ID":"EUR","OPPORTUNITY":1000000,"IS_MANUAL_OPPORTUNITY":"Y","TAX_VALUE":0.10,"COMPANY_ID":9,"CONTACT_IDS":[84,83],"BEGINDATE":"'"$(date --iso-8601=seconds)"'","CLOSEDATE":"'"$(date --iso-8601=seconds --date='+10 days')"'", "OPENED":"Y","CLOSED":"N","COMMENTS":"Example comment","SOURCE_ID":"CALLBACK","SOURCE_DESCRIPTION":"Additional information about the source","ADDITIONAL_INFO":"Additional information","UTM_SOURCE":"google","UTM_MEDIUM":"CPC","PARENT_ID_1220":22,"UF_CRM_1721244482250":"Hello world!"},"PARAMS":{"REGISTER_SONET_EVENT":"N"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FIELDS":{"TITLE":"New Deal #1","TYPE_ID":"COMPLEX","CATEGORY_ID":0,"STAGE_ID":"PREPARATION","IS_RECURRING":"N","IS_RETURN_CUSTOMER":"Y","IS_REPEATED_APPROACH":"Y","PROBABILITY":99,"CURRENCY_ID":"EUR","OPPORTUNITY":1000000,"IS_MANUAL_OPPORTUNITY":"Y","TAX_VALUE":0.10,"COMPANY_ID":9,"CONTACT_IDS":[84,83],"BEGINDATE":"'"$(date --iso-8601=seconds)"'","CLOSEDATE":"'"$(date --iso-8601=seconds --date='+10 days')"'", "OPENED":"Y","CLOSED":"N","COMMENTS":"Example comment","SOURCE_ID":"CALLBACK","SOURCE_DESCRIPTION":"Additional information about the source","ADDITIONAL_INFO":"Additional information","UTM_SOURCE":"google","UTM_MEDIUM":"CPC","PARENT_ID_1220":22,"UF_CRM_1721244482250":"Hello world!"},"PARAMS":{"REGISTER_SONET_EVENT":"N"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.add

try
        {
        	const day = 60 * 60 * 24 * 1000;
        	
        	const now = new Date();
        	const after10Days = new Date(now.getTime() + 10 * day);
        	
        	const response = await $b24.callMethod(
        		'crm.deal.add',
        		{
        			fields: {
        				TITLE: "New Deal #1",
        				TYPE_ID: "COMPLEX",
        				CATEGORY_ID: 0,
        				STAGE_ID: "PREPARATION",
        				IS_RECURRING: "N",
        				IS_RETURN_CUSTOMER: "Y",
        				IS_REPEATED_APPROACH: "Y",
        				PROBABILITY: 99,
        				CURRENCY_ID: "EUR",
        				OPPORTUNITY: 1000000,
        				IS_MANUAL_OPPORTUNITY: "Y",
        				TAX_VALUE: 0.10,
        				COMPANY_ID: 9,
        				CONTACT_IDS: [84, 83],
        				BEGINDATE: now.toISOString(),
        				CLOSEDATE: after10Days.toISOString(),
        				OPENED: "Y",
        				CLOSED: "N",
        				COMMENTS: "[B]Example comment[/B]",
        				SOURCE_ID: "CALLBACK",
        				SOURCE_DESCRIPTION: "Additional information about the source",
        				ADDITIONAL_INFO: "Additional information",
        				UTM_SOURCE: "google",
        				UTM_MEDIUM: "CPC",
        				PARENT_ID_1220: 22,
        				UF_CRM_1721244482250: "Hello world!",
        			},
        			params: {
        				REGISTER_SONET_EVENT: "N",
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $fields = [
                'TITLE' => 'New Deal',
                'TYPE_ID' => 'GIG',
                'CATEGORY_ID' => '1',
                'STAGE_ID' => 'C1:NEW',
                'CURRENCY_ID' => 'USD',
                'OPPORTUNITY' => '10000',
                'BEGINDATE' => (new DateTime())->format(DateTime::ATOM),
                'CLOSEDATE' => (new DateTime('+1 month'))->format(DateTime::ATOM),
                'COMMENTS' => 'This is a test deal.',
            ];
            $params = [
                'REGISTER_SONET_EVENT' => 'Y',
            ];
            $result = $serviceBuilder
                ->getCRMScope()
                ->deal()
                ->add($fields, $params);
            print($result->getId());
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }

const day = 60 * 60 * 24 * 1000;
        
        const now = new Date();
        const after10Days = new Date(now.getTime() + 10 * day);
        
        BX24.callMethod(
            'crm.deal.add',
            {
                fields: {
                    TITLE: "New Deal #1",
                    TYPE_ID: "COMPLEX",
                    CATEGORY_ID: 0,
                    STAGE_ID: "PREPARATION",
                    IS_RECURRING: "N",
                    IS_RETURN_CUSTOMER: "Y",
                    IS_REPEATED_APPROACH: "Y",
                    PROBABILITY: 99,
                    CURRENCY_ID: "EUR",
                    OPPORTUNITY: 1000000,
                    IS_MANUAL_OPPORTUNITY: "Y",
                    TAX_VALUE: 0.10,
                    COMPANY_ID: 9,
                    CONTACT_IDS: [84, 83],
                    BEGINDATE: now.toISOString(),
                    CLOSEDATE: after10Days.toISOString(),
                    OPENED: "Y",
                    CLOSED: "N",
                    COMMENTS: "[B]Example comment[/B]",
                    SOURCE_ID: "CALLBACK",
                    SOURCE_DESCRIPTION: "Additional information about the source",
                    ADDITIONAL_INFO: "Additional information",
                    UTM_SOURCE: "google",
                    UTM_MEDIUM: "CPC",
                    PARENT_ID_1220: 22,
                    UF_CRM_1721244482250: "Hello world!",
                },
                params: {
                    REGISTER_SONET_EVENT: "N",
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.add',
            [
                'FIELDS' => [
                    'TITLE' => 'New Deal #1',
                    'TYPE_ID' => 'COMPLEX',
                    'CATEGORY_ID' => 0,
                    'STAGE_ID' => 'PREPARATION',
                    'IS_RECURRING' => 'N',
                    'IS_RETURN_CUSTOMER' => 'Y',
                    'IS_REPEATED_APPROACH' => 'Y',
                    'PROBABILITY' => 99,
                    'CURRENCY_ID' => 'EUR',
                    'OPPORTUNITY' => 1000000,
                    'IS_MANUAL_OPPORTUNITY' => 'Y',
                    'TAX_VALUE' => 0.10,
                    'COMPANY_ID' => 9,
                    'CONTACT_IDS' => [84, 83],
                    'BEGINDATE' => (new DateTime())->format(DateTime::ATOM),
                    'CLOSEDATE' => (new DateTime('+10 days'))->format(DateTime::ATOM),
                    'OPENED' => 'Y',
                    'CLOSED' => 'N',
                    'COMMENTS' => 'Example comment',
                    'SOURCE_ID' => 'CALLBACK',
                    'SOURCE_DESCRIPTION' => 'Additional information about the source',
                    'ADDITIONAL_INFO' => 'Additional information',
                    'UTM_SOURCE' => 'google',
                    'UTM_MEDIUM' => 'CPC',
                    'PARENT_ID_1220' => 22,
                    'UF_CRM_1721244482250' => 'Hello world!',
                ],
                'PARAMS' => [
                    'REGISTER_SONET_EVENT' => 'N',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": 394,
            "time": {
                "start": 1725013197.635808,
                "finish": 1725013198.580873,
                "duration": 0.9450650215148926,
                "processing": 0.6822988986968994,
                "date_start": "2024-08-30T12:19:57+02:00",
                "date_finish": "2024-08-30T12:19:58+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer`	Root element of the response, contains the identifier of the created deal
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Parameter 'fields' must be array."
        }

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	Value
`-`	`Parameter 'fields' must be array`	The parameter `fields` is not an object
`-`	`Parameter 'params' must be array`	The parameter `params` is not an object
`-`	`Access denied`	The user does not have permission to "add" deals
`-`	Disk resource exhausted
`-`	Invalid value for the "Currency" field

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of methods

Update a deal

Create a new deal crm.deal.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter paramsParameter params

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