The following is an example of a Online Action Form:
{
"formTrackingId": "j_STKe8rYxkEVvg2",
"formName": "My Event Form",
"formType": "EventSignupForm",
"formTypeId": 11,
"dateCreated": "2019-12-09T00:09:00Z",
"createdByEmail": "[email protected]",
"dateModified": "2019-12-11T03:47:00Z",
"modifiedByEmail": "[email protected]",
"isActive": true,
"designation": {
"designationId": 123456789,
"name": "Jane for Congress Committee"
},
"confirmationEmailData": {
"fromEmail": "[email protected]",
"fromName": "Jim",
"fromSubject": "Thank you for signing up",
"replyToEmail": "[email protected]",
"copyToEmails": [
"[email protected]",
"[email protected]",
"[email protected]"
],
"isConfirmationEmailEnabled": true,
"isRecurringEmailEnabled": true
},
"activistCodes": [
1234567,
4567890,
1230789,
1472583
],
"eventId": 123456,
"codeId": null,
"campaignId": 7777,
"isConfirmedOptInEnabled": false
}
Online Actions Form
Each Online Actions Form has the following properties:
| Property | Type | Description |
|---|---|---|
formTrackingId | string | Unique identifer for specific forms |
formName | string | The Display Name for the form |
formType | string | The name for the form type |
formTypeId | int | The ID for the form type |
dateCreated | date | The date the form was created |
createdByEmail | string | The email address of the user who created the form |
dateModified | date | The date the form was last modified, may return null |
modifiedByEmail | string | The email address of the user who last modified the form, may return null |
isActive | bool | If the form is active or not |
designation | object | A Designation object if the form accepts payments |
confirmationEmailData | object | An object containing confirmation email data |
eventId | int | The ID for an Event, if there is an event associated with the form. Otherwise it returns null. |
codeId | int | The ID of the Code, if one is attached to the form. Otherwise it returns null. |
activistCodes | array | An array of Activist Code IDs. May return null |
campaignId | int | The ID of a campaign if one is applied otherwise it returns null |
isConfirmedOptInEnabled | bool | If Confirmed Opt In is enabled or not |
Confirmation Email Data
All Confirmation Email Data is optional. If confirmation email information was added to the form that data will be returned.
| Property | Type | Description |
|---|---|---|
fromEmail | string | The email address where the confirmation email comes from. Otherwise it returns null. |
fromName | string | The name of the person the confirmation email comes from. Otherwise it returns null. |
fromSubject | string | The subject the confirmation email was sent with. Otherwise it returns null. |
replyToEmail | string | The ‘reply to’ email address for the confirmation email. Otherwise it returns null. |
copyToEmails | array | An array of ‘copy to’ email addresses |
isConfirmationEmailEnabled | bool | A flag for if the confirmation email is enabled |
isRecurringEmailEnabled | bool | A flag for if recurring email is enabled |