MyForms integration

Send Workflow Fax

Perform Send Workflow Fax through MyForms.

View as Markdown

myforms_send_workflow_fax

write

Inputs

workflow_id
textrequired
Workflow Id
Required text value.
document_ids
jsonrequired
Document Ids
Required JSON value.
recipient_name
textrequired
Recipient Name
Required text value.
recipient_fax_number
textrequired
Recipient Fax Number
Required text value.
recipient_phone_number
text
Recipient Phone Number
Optional text value.
cover_sheet_title
textrequired
Cover Sheet Title
Required text value.
cover_sheet_id
text
Cover Sheet Id
Optional text value.
notes_html
textarea
Notes Html
Optional text value.
fax_number_id
text
Fax Number Id
Optional text value.
timeout_seconds
number
Timeout Seconds
Optional numeric value.
Default: 180

Outputs

successSuccess
sentSent
document_idsDocument Ids
error_messageError Message

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": [
    "workflow_id",
    "document_ids",
    "recipient_name",
    "recipient_fax_number",
    "cover_sheet_title"
  ],
  "properties": {
    "notes_html": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "workflow_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "document_ids": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "fax_number_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "cover_sheet_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "recipient_name": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "timeout_seconds": {
      "type": "number",
      "default": 180,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "cover_sheet_title": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "recipient_fax_number": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "recipient_phone_number": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "sent": {},
    "success": {},
    "document_ids": {},
    "error_message": {}
  },
  "additionalProperties": true
}

View all MyForms actions