Instructions

Short messages to provide additional context to a customer which change as a unioned action status changes. These messages are sent in messages in addition to being shown on the web.

When displayed in a message, all instructions within a business process are grouped together at the start of a message, or sent as its own message.

Instructions messages will be displayed as per unioned action status.

⚠️
Warning
Large instructions block can result in larger or more messages being sent to customers

No products are required to use this action.

This action pairs well with the following actions.

State

The state will contain the instruction message as per unioned action status.

Union (required)

An instruction action depends on being unioned to another in order to know what message to display.

Macro level details for how union attribute behaves can be found within the Union documentation.

Context (required)

Name	Type	Description	Rules
in-progress	string	When the unioned action is in progress, this message will display. Examples: "When its in progress, do your best.".	MaxLength: 256 MinLength: 3
failed	string	When the unioned action is failed, this message will display. Examples: "Total failure.".	MaxLength: 256 MinLength: 3
resolved	string	When the unioned action is resolved, this message will display. Examples: "It's resolved, no need to try.".	MaxLength: 256 MinLength: 3
reminder	string	When the unioned action is reminder, this message will display(Deprecated).	MaxLength: 256 MinLength: 3

Example

Below is an example payload for adding an action to a business process or blueprint.

{
    "type": "instructions",
    "union": 1,
    "context": {
        "in-progress": "When its in progress, do your best.",
        "failed": "Total failure.",
        "resolved": "It's resolved, no need to try."
    }
}