flow

Download 2
Last updated May 11, 2026

flow-deactivate-employee

Deactivate an employee in flow.

Options:

  • emp_key (STRING, required): Target employee key
  • emp_name (STRING, required): Employee name
  • dept_code (STRING, optional): Department code
  • emp_title (STRING, optional): Job title
  • mobile (STRING, optional): Mobile phone number
  • phone (STRING, optional): Company phone number
  • email (STRING, optional): Email address Note: flow API clears optional fields not included in the request on deactivation. Specify optional fields to preserve existing data.
flow-deactivate-employee profile=PROFILE emp-key=EMP-KEY emp-name=EMP-NAME [dept-code=DEPT-CODE] [emp-title=EMP-TITLE] [mobile=MOBILE] [phone=PHONE] [email=EMAIL] [dry-run=DRY-RUN]
profile=PROFILE
flow connect profile
emp-key=EMP-KEY
Target employee key
emp-name=EMP-NAME
Employee name
dept-code=DEPT-CODE
Department code
emp-title=EMP-TITLE
Job title
mobile=MOBILE
Mobile phone number
phone=PHONE
Company phone number
email=EMAIL
Email address
dry-run=DRY-RUN
Dry run mode (t or f, default: t)

Output Fields

FieldTypeNameDescription
_resultStringResultsuccess or fail