Essette integration

Set Preferred Contact

Perform Set Preferred Contact through Essette.

View as Markdown

essette_set_preferred_contact

writeessette

Inputs

essette_account_id
selectrequireddynamic options
Essette Account Id
Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
Default: "primary"
auth_id
expressionrequired
Auth Id
Required literal value or workflow expression.
contact_name
expressionrequired
Contact Name
Required literal value or workflow expression.
email
expression
Email
Optional literal value or workflow expression.
phone
expression
Phone
Optional literal value or workflow expression.
phone_extension
expression
Phone Extension
Optional literal value or workflow expression.
fax
expression
Fax
Optional literal value or workflow expression.

Outputs

successSuccess
auth_idAuth Id
errorError
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": [
    "essette_account_id",
    "auth_id",
    "contact_name"
  ],
  "properties": {
    "fax": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "email": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "phone": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "auth_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "contact_name": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "phone_extension": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "essette_account_id": {
      "type": "string",
      "default": "primary",
      "description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    }
  },
  "additionalProperties": false
}

Output schema

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

View all Essette actions