Step Messages
- Aaron Pettit (Unlicensed)
- Terra Yi (Unlicensed)
Owned by Aaron Pettit (Unlicensed)
The information in this document is currently in BETA and subject to change.
The Steps Messages resource represent messages on a step. Refer to the Action Create resource for usage.
Resource Properties
| Scope Parameter | stepmessages |
|---|---|
| Location | /stepmessages |
| Methods | GET |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|---|---|---|---|---|---|
| id | string | default | ||||
| method | string | default | ||||
| subject | string | default | ||||
| message | string | default | ||||
| messageHtml | string | default | ||||
| isMandatory | boolean | default | ||||
| actionType | string | link | ||||
| step | string | link | ||||
| fromParticipantType | string | link | ||||
| toParticipantType | string | link |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| stepmessages.actionType | actiontypes | /actiontypes/{stepmessages.actionType} |
| stepmessages.step | steps | /steps/{stepmessages.step} |
| stepmessages.fromParticipantType | participanttypes | /participanttypes/{stepmessages.fromParticipantType} |
| stepmessages.toParticipantType | participanttypes | /participanttypes/{stepmessages.toParticipantType} |