Create a Step object

Audience:

api

•

Version: 10.3.5

Some tooltip text!

• 1 minute to read

 • 1 minute to read

Use the CreateDefaultWorkflowStepFromType REST endpoint to generate a new carrier with default settings, based on the type of step. This endpoint returns a pre-populated Step object configured with values corresponding to the selected StepType.

Similar to triggers, WorkflowStepId and WorkflowId are automatically assigned by the system upon creation and are not mandatory. These properties are excluded in the examples.

Note

If no Rank is specified in the Step object, the system will determine the Rank automatically based on the order of elements in the object.

Request

POST https://{{env}}.superoffice.com/{{tenant}}/v1/Agents/Workflow/CreateDefaultWorkflowStepFromType HTTP/1.1
Authorization: Bearer {{access_token}}
Accept: application/json
Content-Type: application/json; charset=utf-8

{
    "StepType": "WaitForTime",
}

Response

{
  "TimeWaitAlgorithm": "None",
  "NumIntervals": 0,
  "IntervalType": "None",
  "Until": null,
  "WorkflowStepId": 0,
  "WorkflowId": 0,
  "StepType": "WaitForTime",
  "Rank": 0
}

In the case of a 'WaitForTime' StepType you have the following examples for each of them:

{
    "TimeWaitAlgorithm": "NumIntervals",
    "NumIntervals": 7,
    "IntervalType": "Days",
    "Until": "[DT:05/31/2024 14:24:23]",
    "StepType": "WaitForTime",
    "Rank": 1
}

and

{
    "TimeWaitAlgorithm": "UntilSpecified",
    "NumIntervals": 7,
    "IntervalType": "Days",
    "Until": "[DT:05/31/2024 14:24:23]",
    "StepType": "WaitForTime",
    "Rank": 1
}