NGngpvan

/onlineActionsForms/{formTrackingId}

Changed on

Use this endpoint to retrieve information about a specific Online Actions Form available in the current context.

This endpoint accepts standard list parameters, returns a standard Online Actions Form object.

get/onlineActionsForms/{formTrackingId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/onlineActionsForms/{formTrackingId}
  • Auth
    HTTP basic

Path parameters

formTrackingIdstring required

Required; Unique identifier of the Online Actions Form

Response

200

formTrackingIdstring
formNamestring
formTypestring
formTypeIdinteger
dateCreatedstring
createdByEmailstring
dateModifiedstring
modifiedByEmailstring
isActiveboolean
activistCodesinteger[]
eventIdinteger
codeIdunknown
campaignIdinteger
isConfirmedOptInEnabledboolean

Example response

{
  "formTrackingId": "j_STKe8rYxkEVvg2",
  "formName": "My Event Form",
  "formType": "EventSignupForm",
  "formTypeId": 11,
  "dateCreated": "2019-12-09T00:09:00Z",
  "createdByEmail": "invalid@fake.ngpvan.com",
  "dateModified": "2019-12-11T03:47:00Z",
  "modifiedByEmail": "invalid@fake.ngpvan.com",
  "isActive": true,
  "designation": {
    "designationId": 123456789,
    "name": "Jane for Congress Committee"
  },
  "confirmationEmailData": {
    "fromEmail": "jim@gotham.ci.us",
    "fromName": "Jim",
    "fromSubject": "Thank you for signing up",
    "replyToEmail": "jim@gotham.ci.us",
    "copyToEmails": [
      "jim@gotham.ci.us"
    ],
    "isConfirmationEmailEnabled": true,
    "isRecurringEmailEnabled": true
  },
  "activistCodes": [
    1234567
  ],
  "eventId": 123456,
  "campaignId": 7777
}

Changes