Skip to documentation
Brightree integration

Select Template Schedule Audit Candidates

Perform Select Template Schedule Audit Candidates through Brightree.

View as Markdown
brightree_select_template_schedule_audit_candidates
writebrightree

Inputs

  • account_key
    text
    Account Key

    Optional text value.

  • start_date
    date
    Start Date

    Optional date in YYYY-MM-DD format.

  • end_date
    date
    End Date

    Optional date in YYYY-MM-DD format.

  • max_candidates
    numberrequired
    Max Candidates

    Required numeric value.

    Default: 5000

Outputs

  • successSuccess
  • templatesTemplates
  • countCount
  • start_dateStart Date
  • end_dateEnd Date
  • messageMessage
  • 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": [
    "max_candidates"
  ],
  "properties": {
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "account_key": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_candidates": {
      "type": "number",
      "default": 5000,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "message": {},
    "success": {},
    "end_date": {},
    "templates": {},
    "start_date": {}
  },
  "additionalProperties": true
}
View all Brightree actions