COcoevera
Step

StepChecklists.create

Creates a StepChecklist record.

post/entities/StepChecklists

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

activity_type_idstring uuid

Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based.

cloud_object_format0 | 1

File format of the document generated from cloud_object_template when item_type is UseDocumentTemplate: the template's own format or PDF.

Integer enum value: 0 - Default, 1 - Pdf

cloud_object_template_idstring uuid

Id of the document template the checklist item fills and attaches to the record. Set when item_type is UseDocumentTemplate.

descriptionstring

Free-text description shown alongside the checklist item.

email_sequence_idstring uuid

Id of the email sequence the record must be enrolled in to complete the item. Set when item_type is EnrollToEmailSequence.

field_idstring uuid

Id of the related field.

item_type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activity_type_id or running process.

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

item_validation1 | 2 | 3

Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when item_type is ActivityType.

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

labelstring

Display label of the checklist item.

label_use_langboolean

When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown.

process_idstring uuid

Id of the related process.

send_email_field_idstring uuid

Id of the recipient field.

send_email_lookup_field_idstring uuid

Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account.

send_email_template_idstring uuid

Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when item_type is SendEmail; empty when no template is preset.

step_idstring uuid required

Id of the pipeline or process step this checklist item belongs to.

visibility_conditionstring binary required

Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. This payload conforms to the StepChecklistVisibilityFilter JSON Schema (see the linked schema).

visibility_type0 | 1

Whether the item is always shown on the record or only when the record matches visibility_condition.

Integer enum value: 0 - Always, 1 - Condition

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "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",
  "process_id": "01234567-abcd-dcba-ffff-000000000000",
  "send_email_field_id": "01234567-abcd-dcba-ffff-000000000000",
  "send_email_lookup_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",
  "revision": 1
}

Response

The created StepChecklist record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "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",
    "process_id": "01234567-abcd-dcba-ffff-000000000000",
    "send_email_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "send_email_lookup_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",
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.