Skip to documentation
Consignment Intake integration

Build Consignment Sender Reply Plans

Perform Build Consignment Sender Reply Plans through Consignment Intake.

View as Markdown
build_consignment_sender_reply_plans
write

Inputs

  • group_email
    textrequired
    Group Email

    Required text value.

  • attachment_collection
    jsonrequired
    Attachment Collection

    Required JSON value.

  • subject_metadata
    jsonrequired
    Subject Metadata

    Required JSON value.

  • message_fetch_results
    jsonrequired
    Message Fetch Results

    Required JSON value.

  • status_summary
    jsonrequired
    Status Summary

    Required JSON value.

  • document_loop_results
    jsonrequired
    Document Loop Results

    Required JSON value.

  • targeted_reprocess
    booleanrequired
    Targeted Reprocess

    Required true-or-false value.

Outputs

  • successSuccess
  • reply_plansReply Plans
  • reply_countReply Count
  • suppressed_countSuppressed Count
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "group_email",
    "attachment_collection",
    "subject_metadata",
    "message_fetch_results",
    "status_summary",
    "document_loop_results",
    "targeted_reprocess"
  ],
  "properties": {
    "group_email": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "status_summary": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "subject_metadata": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "targeted_reprocess": {
      "type": "boolean",
      "description": "Required true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "attachment_collection": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "document_loop_results": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "message_fetch_results": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "reply_count": {},
    "reply_plans": {},
    "suppressed_count": {}
  },
  "additionalProperties": true
}
View all Consignment Intake actions