---
title: "Create action instance"
method: POST
path: "/action-runtime/action-instances"
tags: ["Action Instances"]
---

# Create action instance

`POST /action-runtime/action-instances`

## Request

- Base URL: `http://localhost:8090/action-api`
- URL: `http://localhost:8090/action-api/action-runtime/action-instances`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-action-rest-api/docs/action-runtime/action-instances/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- CreateActionInstanceRequest: The request for creating an action instance
  - `actionDefinitionId` string: The id of the action definition that should be used when creating the action instance. One of actionDefinitionId or actionDefinitionKey must be provided.
  - `actionDefinitionKey` string: The key of the action definition that should be used when creating the action instance. One of actionDefinitionId or actionDefinitionKey must be provided.
  - `scopeId` string: The id of the scoped object for which this action instance is being created for. When this property is set, then scopeType must also be set.
  - `scopeType` string: The type of the scoped object for which this action instance is being created for. When this property is set then scopeId must also be set.
  - `scopeDefinitionId` string: The definition id of the scoped object for which the action instance is being created for.
  - `formInstanceId` string: The id of the form instance that is linked with the action instance.
  - `priority` integer: The priority of the action instance. If not set it will use the one from the action definition model.
  - `tenantId` string: The id of the tenant that the created action instance will belong to. By default it is the tenant of the current user. Can only be set by users with admin privileges.

## Response `200`

Indicates the action instance was created and returned.

- ActionInstanceResponse: Response for a runtime action instance
  - `id` string, required: The unique identifier for the action instance.
  - `name` string, required: The name for the action instance.
  - `actionDefinitionId` string, required: The id of the action definition for this action instance.
  - `scopeDefinitionId` string: The optional definition id for the scoped object.
  - `scopeId` string: The optional id of the scope that is linked with this action instance. If this property is set then scopeType is also set.
  - `scopeType` string: The optional type of the scope that is linked with this action instance. If this property is set then scopeId is also set.
  - `startDate` string, required: The starting date of the action instance in ISO 8601 format.
  - `formKey` string: The key of the form linked with this action instance.
  - `formParentDeploymentId` string: The parent deployment id of the form linked with this action instance. If not set it means newest form.
  - `formInstanceId` string: The id of the form instance linked with this action instance.
  - `priority` integer: The optional priority of the action, which can be used for sorting the actions
  - `tenantId` string: The id of the tenant that this action instance belongs to.

## Other responses

- `403`: Indicates the user does not have access to create the action instance.
- `404`: Indicates the requested action definition was not found.

---

[API](https://skmtc.dev/flowable/apis/flowable-action-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-action-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-action-rest-api/revisions/d8a514102707?raw)