Steps.create - PipelinerCRM

Creates new Step

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Step on create. 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.

Body Params application / json

description

string

optional

Multi-line text input field.

Example:

string

has_readonly_form

boolean

optional

Boolean value.

Example:

false

has_version_increment

boolean

optional

Boolean value.

Example:

false

lead_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

name

string

required

Name of the entity and its default text representation.

Example:

string

percent

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

quote_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sort_order

integer <int32>

optional

Example:

timeframe

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

step_checklists

array [object {1}]

optional

Relations to StepChecklists.

string <uri>

optional

Example

{
    "description": "string",
    "has_readonly_form": false,
    "has_version_increment": false,
    "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "percent": 1,
    "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "timeframe": 1,
    "revision": 1,
    "documents": [
        {
            "id": "http://example.com"
        }
    ],
    "step_checklists": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Step

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Step)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

lead_process

string <uri>

optional

Relation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties.

pipeline

string <uri>

read-onlyoptional

Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties.

quote_process

string <uri>

optional

Relation to QuoteProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteProcess' object for properties.

description

string

optional

Multi-line text input field.

Example:

string

has_readonly_form

boolean

optional

Boolean value.

Example:

false

has_version_increment

boolean

optional

Boolean value.

Example:

false

lead_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

name

string

required

Name of the entity and its default text representation.

Example:

string

percent

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

pipeline_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quote_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sort_order

integer <int32>

optional

Example:

timeframe

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

documents

array[string <uri>]

optional

Relations to CloudObjects.

step_checklists

array[string <uri>]

optional

Relations to StepChecklists.

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "lead_process": "http://example.com",
        "pipeline": "http://example.com",
        "quote_process": "http://example.com",
        "description": "string",
        "has_readonly_form": false,
        "has_version_increment": false,
        "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "percent": 1,
        "pipeline_id": "01234567-abcd-dcba-ffff-000000000000",
        "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "sort_order": 1,
        "timeframe": 1,
        "revision": 1,
        "documents": [
            "http://example.com"
        ],
        "step_checklists": [
            "http://example.com"
        ]
    }
}

🔴500Server Error