INPUT_OBJECT

CreateOrUpdateStepChecklistInput

Field values of a StepChecklist record to create, or to update when its id is set.

link GraphQL Schema definition

  • input CreateOrUpdateStepChecklistInput {
  • # Optional client-supplied identifier passed on a mutation input and echoed back
  • # unchanged on its payload, so a client can correlate the response with its
  • # request (Relay convention).
  • clientMutationId: String
  • # Unique identifier of entity.
  • id: ID
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Document template the checklist item fills and attaches to the record. Set when
  • # itemType is UseDocumentTemplate.
  • cloudObjectTemplate: CreateCloudObjectTemplateInput
  • # Id of the appointment or task type that satisfies the checklist item, or empty
  • # when the item is not activity-based.
  • activityTypeId: ID
  • # File format of the document generated from cloudObjectTemplate when itemType is
  • # UseDocumentTemplate: the template's own format or PDF.
  • cloudObjectFormat: StepChecklistDocumentFormatEnum
  • # Id of the document template the checklist item fills and attaches to the record.
  • # Set when itemType is UseDocumentTemplate.
  • cloudObjectTemplateId: ID
  • # Free-text description shown alongside the checklist item.
  • description: String
  • # Id of the email sequence the record must be enrolled in to complete the item.
  • # Set when itemType is EnrollToEmailSequence.
  • emailSequenceId: ID
  • # Id of the related field.
  • fieldId: ID
  • # Kind of checklist item, which determines what completes it, such as checking it
  • # off, filling in field, logging an activity of activityTypeId or running process.
  • itemType: StepChecklistTypeEnum
  • # Condition the item must meet before the record can move past the step; empty
  • # when the item is optional. RelatedActivityCompleted is allowed only when
  • # itemType is ActivityType.
  • itemValidation: StepChecklistValidationEnum
  • # Display label of the checklist item.
  • label: String
  • # When true, label is treated as a translation key and localized in the UI;
  • # otherwise the literal text is shown.
  • labelUseLang: Boolean
  • # Id of the related process.
  • processId: ID
  • # Id of the recipient field.
  • sendEmailFieldId: ID
  • # 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.
  • sendEmailLookupFieldId: ID
  • # Id of the email template the email is pre-filled with when the item is completed
  • # by sending an email. Set when itemType is SendEmail; empty when no template is
  • # preset.
  • sendEmailTemplateId: ID
  • # Id of the pipeline or process step this checklist item belongs to.
  • stepId: ID
  • # 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:
  • # https://api-doc.coevera.com/schemas/StepChecklistVisibilityFilter.json
  • visibilityCondition: StepChecklistVisibilityFilterJSONString
  • # Whether the item is always shown on the record or only when the record matches
  • # visibilityCondition.
  • visibilityType: StepChecklistVisibilityEnum
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Sales roles the checklist item is shown to. Empty means the item is shown to all
  • # roles.
  • salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!]
  • }

link Require by