StepChecklists.create - PipelinerCRM

Creates new StepChecklist

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of StepChecklist 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

cloud_object_template

object

optional

Relation to CloudObjectTemplate, see: 'createCloudObjectTemplateInput' object for properties.

string <uri>

optional

activity_type_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_format

enum<integer>

optional

Integer enum value: 0 - Default, 1 - Pdf

Allowed values:

Example:

cloud_object_template_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

email_sequence_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

item_type

enum<integer>

optional

Integer enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap

Allowed values:

1234567891011

Example:

item_validation

enum<integer>

optional

Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked

Allowed values:

123

Example:

label

string

optional

Multi-line text input field.

Example:

string

label_use_lang

boolean

optional

Boolean value.

Example:

false

process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

send_email_field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

send_email_template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

step_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

visibility_condition

string <binary>

required

Example:

blob

visibility_type

enum<integer>

optional

Integer enum value: 0 - Always, 1 - Condition

Allowed values:

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sales_roles

array [object {1}]

optional

Relations to SalesRoles.

string <uri>

optional

Example

{
    "cloud_object_template": {
        "id": "http://example.com"
    },
    "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "cloud_object_format": 0,
    "cloud_object_template_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "field_id": "01234567-abcd-dcba-ffff-000000000000",
    "item_type": 1,
    "item_validation": 1,
    "label": "string",
    "label_use_lang": false,
    "process_id": "01234567-abcd-dcba-ffff-000000000000",
    "send_email_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "send_email_template_id": "01234567-abcd-dcba-ffff-000000000000",
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "visibility_condition": "blob",
    "visibility_type": 0,
    "revision": 1,
    "sales_roles": [
        {
            "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 StepChecklist

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (StepChecklist)

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

appointment_type

string <uri>

optional

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

task_type

string <uri>

optional

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

cloud_object_template

string <uri>

optional

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

email_sequence

string <uri>

optional

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

field

string <uri>

optional

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

process

string <uri>

optional

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

send_email_field

string <uri>

optional

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

send_email_template

string <uri>

optional

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

step

string <uri>

required

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

activity_type_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_format

enum<integer>

optional

Integer enum value: 0 - Default, 1 - Pdf

Allowed values:

Example:

cloud_object_template_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

email_sequence_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

item_type

enum<integer>

optional

Allowed values:

1234567891011

Example:

item_validation

enum<integer>

optional

Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked

Allowed values:

123

Example:

label

string

optional

Multi-line text input field.

Example:

string

label_use_lang

boolean

optional

Boolean value.

Example:

false

process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

send_email_field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

send_email_template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sort_order

integer <int32>

read-onlyrequired

Example:

step_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

visibility_condition

string <binary>

required

Example:

blob

visibility_type

enum<integer>

optional

Integer enum value: 0 - Always, 1 - Condition

Allowed values:

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sales_roles

array[string <uri>]

optional

Relations to SalesRoles.

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",
        "appointment_type": "http://example.com",
        "task_type": "http://example.com",
        "cloud_object_template": "http://example.com",
        "email_sequence": "http://example.com",
        "field": "http://example.com",
        "process": "http://example.com",
        "send_email_field": "http://example.com",
        "send_email_template": "http://example.com",
        "step": "http://example.com",
        "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_format": 0,
        "cloud_object_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
        "field_id": "01234567-abcd-dcba-ffff-000000000000",
        "item_type": 1,
        "item_validation": 1,
        "label": "string",
        "label_use_lang": false,
        "process_id": "01234567-abcd-dcba-ffff-000000000000",
        "send_email_field_id": "01234567-abcd-dcba-ffff-000000000000",
        "send_email_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "sort_order": 1,
        "step_id": "01234567-abcd-dcba-ffff-000000000000",
        "visibility_condition": "blob",
        "visibility_type": 0,
        "revision": 1,
        "sales_roles": [
            "http://example.com"
        ]
    }
}

🔴500Server Error