API Reference
Log In
API Reference

Smart Forms Requests

Describes the Smart Form and its defined roles.


{
  "smartFormsId": "{smartFormsId}",
  "roles": [
    {
      "role": "",
      "routingOrder": 0,
      "roleOpenId": "auth0|12345abcde",
      "roleFederationId": "{federationid}",
      "roleInvitationCode": "",
      "region": "CA",
      "roleTeamId": "",
      "roleEmail": "",
      "roleName": "Jane Smith"
    }
  ]
}

Smart Forms (smartForms) entity

smartFormsId string required
Unique Smart Form identifier.

roles array of Smart Forms Roles entities required
Contributor(s) to the Smart Form.


Smart Forms Roles (roles) entity

role string required
Role name.

routingOrder number required
Routing order.

roleOpenId string
Role OpenID. May use roleEmail or roleFederationId instead.

roleFederationId string
Unique federation identifier.

roleInvitationCode string
Invitation code.

region string
User role region.

roleTeamId string
Unique team identifier.

roleEmail string
Role email address.

roleName string
Role name. Required if you want to display something other than the role value.