Create Authorization
Perform Create Authorization through Essette.
essette_create_authorizationInputs
- Essette Account Id
essette_account_idselectrequireddynamic optionsRequired selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
Default:
"primary" - Plan Id
plan_idexpressionrequiredRequired literal value or workflow expression.
- Auth Class
auth_classselectdynamic optionsOptional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
Default:
"DME" - Auth Subclass
auth_subclassselectrequireddynamic optionsRequired selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
- Auth Type
auth_typeselectdynamic optionsOptional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
Default:
"PREI" - Service Date Start
service_date_startexpressionrequiredRequired literal value or workflow expression.
- Service Date End
service_date_endexpressionrequiredRequired literal value or workflow expression.
- Provider Location Id
provider_location_idselectdynamic optionsOptional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
- Requested By Id
requested_by_idexpressionOptional literal value or workflow expression.
Outputs
successSuccessauth_idAuth Idincomplete_auth_id_for_recoveryIncomplete Auth Id For Recoveryauth_numberAuth Numberclass_idClass Idsubclass_idSubclass Idtype_idType Idprovider_location_idProvider Location Idrequested_by_idRequested By IderrorErrorerror_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",
"plan_id",
"auth_subclass",
"service_date_start",
"service_date_end"
],
"properties": {
"plan_id": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"auth_type": {
"type": "string",
"default": "PREI",
"description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
"x-dynamic-options": true,
"x-workflow-field-type": "select"
},
"auth_class": {
"type": "string",
"default": "DME",
"description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
"x-dynamic-options": true,
"x-workflow-field-type": "select"
},
"auth_subclass": {
"type": "string",
"description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
"x-dynamic-options": true,
"x-workflow-field-type": "select"
},
"requested_by_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"service_date_end": {
"description": "Required 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"
},
"service_date_start": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"provider_location_id": {
"type": "string",
"description": "Optional 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": {},
"type_id": {},
"class_id": {},
"auth_number": {},
"subclass_id": {},
"error_message": {},
"requested_by_id": {},
"provider_location_id": {},
"incomplete_auth_id_for_recovery": {}
},
"additionalProperties": true
}