Brightree integration

Assign Fax to User

Perform Assign Fax to User through Brightree.

View as Markdown

brightree_assign_fax_to_user

writebrightree

Inputs

fax_key
expression
Fax Key
Optional literal value or workflow expression.
user_name
text
User Name
Optional text value.
user_key
number
User Key
Optional numeric value.
received_date_from
date
Received Date From
Optional date in YYYY-MM-DD format.
received_date_to
date
Received Date To
Optional date in YYYY-MM-DD format.
work_status
text
Work Status
Optional text value.
show_unassigned
boolean
Show Unassigned
Optional true-or-false value.
branch_offices
multi_selectdynamic options
Branch Offices
Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.

Outputs

successSuccess
fax_keyFax Key
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",
  "properties": {
    "fax_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "user_key": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "user_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "work_status": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "branch_offices": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "multi_select"
    },
    "show_unassigned": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "received_date_to": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "received_date_from": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "fax_key": {},
    "success": {}
  },
  "additionalProperties": true
}

View all Brightree actions