Step Messages

Owned by Aaron Pettit (Unlicensed)
Last updated: May 31, 2019 by Terra Yi (Unlicensed)Version comment
1 min read
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 Parameterstepmessages
Location/stepmessages
MethodsGET
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
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
IdentifierResourceLocation Template
stepmessages.actionTypeactiontypes/actiontypes/{stepmessages.actionType}
stepmessages.stepsteps/steps/{stepmessages.step}
stepmessages.fromParticipantTypeparticipanttypes/participanttypes/{stepmessages.fromParticipantType}
stepmessages.toParticipantTypeparticipanttypes/participanttypes/{stepmessages.toParticipantType}