Leads.batch_create_or_update

Create or update an batch of Leads

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Leads on change. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

rollback-method

integer <int32>

optional

Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records.

Body Params application / json

array of:

created

string <date-time>

optional

Creation time.

Example:

2019-01-01T00:00:00

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

is_archived

boolean

optional

Boolean value.

Example:

false

label_flag

enum<string>

optional

Opportunity label flag.

Options:
Priority = 1 (0b001)
Hot = 2 (0b010)
Stalled = 4 (0b100)

Allowed values:

124

Example:

lead_source_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

name

string

optional

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quick_account_email

string

optional

Simple text input field.

Example:

string

quick_account_name

string

optional

Simple text input field.

Example:

string

quick_account_phone

string

optional

Simple text input field.

Example:

string

quick_contact_name

string

optional

Simple text input field.

Example:

string

quick_email

string

optional

Simple text input field.

Example:

string

quick_phone

string

optional

Simple text input field.

Example:

string

ranking

integer <int32>

optional

Qualitative ranking of the opportunity.

Example:

reason_of_close_description

string

optional

Multi-line text input field.

Example:

string

reason_of_close_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

step_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

contact_relations

array [object {1}]

optional

Relations to Contacts.

string <uri>

optional

account_relations

array [object {1}]

optional

Relations to Accounts.

string <uri>

optional

sharing_units

array [object {1}]

optional

Relations to SalesUnits.

string <uri>

optional

sharing_clients

array [object {1}]

optional

Relations to Clients.

string <uri>

optional

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

tags

array [object {1}]

optional

Relations to Tags.

string <uri>

optional

static_profiles

array [object {1}]

optional

Relations to Profiles.

string <uri>

optional

lost_date

string <date-time>

optional

Example:

2019-01-01T00:00:00

string <uuid>

optional

ID of object to update.

Example

[
    {
        "created": "2019-01-01T00:00:00",
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "is_archived": false,
        "label_flag": 1,
        "lead_source_id": "01234567-abcd-dcba-ffff-000000000000",
        "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "quick_account_email": "string",
        "quick_account_name": "string",
        "quick_account_phone": "string",
        "quick_contact_name": "string",
        "quick_email": "string",
        "quick_phone": "string",
        "ranking": 1,
        "reason_of_close_description": "string",
        "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
        "share_mode": 0,
        "step_id": "01234567-abcd-dcba-ffff-000000000000",
        "unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "contact_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "account_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "sharing_units": [
            {
                "id": "http://example.com"
            }
        ],
        "sharing_clients": [
            {
                "id": "http://example.com"
            }
        ],
        "documents": [
            {
                "id": "http://example.com"
            }
        ],
        "tags": [
            {
                "id": "http://example.com"
            }
        ],
        "static_profiles": [
            {
                "id": "http://example.com"
            }
        ],
        "lost_date": "2019-01-01T00:00:00",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/Leads/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "created": "2019-01-01T00:00:00",
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "is_archived": false,
        "label_flag": 1,
        "lead_source_id": "01234567-abcd-dcba-ffff-000000000000",
        "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "quick_account_email": "string",
        "quick_account_name": "string",
        "quick_account_phone": "string",
        "quick_contact_name": "string",
        "quick_email": "string",
        "quick_phone": "string",
        "ranking": 1,
        "reason_of_close_description": "string",
        "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
        "share_mode": 0,
        "step_id": "01234567-abcd-dcba-ffff-000000000000",
        "unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "contact_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "account_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "sharing_units": [
            {
                "id": "http://example.com"
            }
        ],
        "sharing_clients": [
            {
                "id": "http://example.com"
            }
        ],
        "documents": [
            {
                "id": "http://example.com"
            }
        ],
        "tags": [
            {
                "id": "http://example.com"
            }
        ],
        "static_profiles": [
            {
                "id": "http://example.com"
            }
        ],
        "lost_date": "2019-01-01T00:00:00",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated Leads

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array [oneOf]

optional

string <uuid>

optional

And ID of created / updated entity.

object (Error)

optional

Example

{
    "success": true,
    "data": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

🔴500Server Error