FAfactorialhr
Processes > MaterializedProcess

Creates a Materialized process

Changed on

Creates a Materialized process

post/api/2026-10-01/resources/processes/materialized_processes

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/processes/materialized_processes
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: processes
    • or API key in header x-api-key

Request body

company_idstring required

identifier of the company the workflow belongs to.

process_idstring required

identifier of the workflow to assign. Read /processes/processes to find it.

employee_idstring

identifier of the employee to assign, refers to the /employees/employees endpoint. The employee needs whatever the workflow's steps read about them — typically manager, team and contract — before being assigned; a step that cannot resolve them blocks until an admin unblocks it.

Example request

{
  "company_id": "1",
  "process_id": "1",
  "employee_id": "1"
}

Response

CREATED

idstring required

identifier of the workflow run.

process_idstring required

identifier of the workflow this run follows. Refers to the /processes/processes endpoint.

statusstring required

state of the run: running while the person is going through it, finalized once every step is done, archived when it was cancelled.

finalized_atstring

when the run finished. Null while it is still running.

Example response

{
  "id": "1",
  "process_id": "1",
  "status": "running",
  "finalized_at": "2026-10-01T09:00:00.000Z"
}

Changes