v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Step

StepChecklists.update

Modifies StepChecklist or StepChecklists with given id(s)

patch/entities/StepChecklists/{id}

Path parameters

idstring uuid required

ID of StepChecklist to update

Query parameters

validation-levelinteger

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

Request body

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

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Default, 1 - Pdf

cloud_object_template_idstring uuid

Id of the cloud object template.

descriptionstring

Free-text description shown alongside the checklist item.

email_sequence_idstring uuid

Id of the email sequence.

field_idstring uuid

Id of the related field.

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

Field whose values are strictly defined with an enumeration of values.

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

Field whose values are strictly defined with an enumeration of values.

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_template_idstring uuid

Id of the email template.

step_idstring uuid

Id of the step.

visibility_conditionstring binary

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.

visibility_type0 | 1

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Always, 1 - Condition

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "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_template_id": "01234567-abcd-dcba-ffff-000000000000",
  "step_id": "01234567-abcd-dcba-ffff-000000000000",
  "visibility_condition": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting StepChecklist

successboolean

True when response 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_template_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "visibility_condition": "blob",
    "revision": 1
  }
}