Sign in

v2

latestOpenAPI 3.0.02026-07-31226285.0 KB
Workflows

createDefinition

Create a new V1 workflow definition. The definition consists of sections and steps that define the structure of the workflow. Once created, the definition can be used to start workflow executions.

post/v1/workflows/definitions

Request body

idstring

Unique identifier for the workflow definition, generated by the system.

namestring required

Display name for the workflow, shown to users in the UI.

descriptionstring

Optional detailed description of the workflow's purpose and behavior.

creationTimestring

ISO String Date & Time

enabledboolean

Whether the workflow is enabled or not

lastUpdateTimestring

ISO String Date & Time

dueDatestring
userIdsnumber[]

This field is deprecated. Please use assignedTo

assignedTostring[]
enableECPWorkflowboolean

Indicates whether this workflow is available for End Customer Portal or not. By default it's not.

taxonomiesstring[]

Taxonomy ids that are associated with this workflow and used for filtering

singleClosingReasonSelectionboolean

Whether only a single closing reason can be selected

_manifeststring[]

The manifest IDs associated with this workflow

Example request

{
  "creationTime": "2021-04-27T12:01:13.000Z",
  "lastUpdateTime": "2021-04-27T12:01:13.000Z",
  "dueDate": "2021-04-27T12:00:00.000Z",
  "flow": [
    {
      "dueDate": "2021-04-27T12:00:00.000Z",
      "steps": [
        {
          "dueDate": "2021-04-27T12:00:00.000Z"
        }
      ]
    }
  ],
  "closingReasons": [
    {
      "id": "x739cew"
    }
  ],
  "updateEntityAttributes": [
    {
      "target": {
        "entitySchema": "opportunity",
        "entityAttribute": "my_status"
      }
    }
  ]
}

Response

Success - if the definition is created successfully

idstring

Unique identifier for the workflow definition, generated by the system.

namestring required

Display name for the workflow, shown to users in the UI.

descriptionstring

Optional detailed description of the workflow's purpose and behavior.

creationTimestring

ISO String Date & Time

enabledboolean

Whether the workflow is enabled or not

lastUpdateTimestring

ISO String Date & Time

dueDatestring
userIdsnumber[]

This field is deprecated. Please use assignedTo

assignedTostring[]
enableECPWorkflowboolean

Indicates whether this workflow is available for End Customer Portal or not. By default it's not.

taxonomiesstring[]

Taxonomy ids that are associated with this workflow and used for filtering

singleClosingReasonSelectionboolean

Whether only a single closing reason can be selected

_manifeststring[]

The manifest IDs associated with this workflow

Example response

{
  "creationTime": "2021-04-27T12:01:13.000Z",
  "lastUpdateTime": "2021-04-27T12:01:13.000Z",
  "dueDate": "2021-04-27T12:00:00.000Z",
  "flow": [
    {
      "dueDate": "2021-04-27T12:00:00.000Z",
      "steps": [
        {
          "dueDate": "2021-04-27T12:00:00.000Z"
        }
      ]
    }
  ],
  "closingReasons": [
    {
      "id": "x739cew"
    }
  ],
  "updateEntityAttributes": [
    {
      "target": {
        "entitySchema": "opportunity",
        "entityAttribute": "my_status"
      }
    }
  ]
}