FlowmageDocs

Add participant

BetaChanges data

Adds a person to an existing party on a Oneflow contract.

Settings

SettingWhat it is
ConnectionRequiredThe Oneflow connection the step signs in with.
Contract idRequiredThe contract's Oneflow id — a number.
Party idRequiredThe party this person joins — a number, from Get contract → parties[].id.
NameRequiredtext
Delivery"email" or "sms" or "email_and_sms" or "same_device" or "none" or "unknown"
E-mailtext
Phone numbertext
Signatorytrue/false
Organizertrue/false
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `oneflow`)
contractIdtext
partyIdtext
nametext
deliveryChannel"email" or "sms" or "email_and_sms" or "same_device" or "none" or "unknown", by default "email"
emailtext
phoneNumbertext
signatorytrue/false
organizertrue/false

Output

FieldType
participantobject
participant.idnumber
Sample output, and the expression for each field
  • participant
    • id1

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "contractId": "<contract id>",
    "deliveryChannel": "email",
    "email": "",
    "name": "<name>",
    "partyId": "<party id>",
    "phoneNumber": ""
  },
  "label": "Add participant",
  "type": "oneflow.addParticipant",
  "version": 1
}