Record Submission Helper Version 2

This document describes the OSDI record submission helper endpoint as implemented by the Action Network.

The record submission helper allows you to create or update a person record and mark that person as having submitted a form at the same time (as well as tag that person).

This saves API calls. POSTing a new submission without the helper would mean you need a link to the person you want to associate the submission with, which would entail either an oData search to look up the existing person or a POST using the person_signup_helper to add the person first. The record submission helper allows you to post a person's data along with a submission, and the helper will automatically create or deduplicate the person and then create a submission for them on the specified form, all in one API call.

The record submission helper takes the normal submission format (described here) with an additional JSON hash with person data, and an optional array of tags to add to the person's record.

People are matched and deduplicated by email address. If a new person is created as part of a POST operation, that person will be subscribed to the email list associated with your API key. If the email address is found, that person's subscription status (subscribed, unsubscribed, etc...) will not be changed unless you pass subscribed in the status field, as described in the people documentation. In that case, the person will be subscribed to the list, even if they were previously unsubscribed. No other status fields are valid on this endpoint.

Items in the optional tags array are matched to existing tags associated with the list matching your API key by name. If a matching tag is found, that tag will be added to the person's record. If not, the tag will be ignored.

An optional triggers object can be added as well, indicating an autoresponse email should be sent back to the activist, which typically thanks them for taking action. Autoresponse emails are only sent from actions created with our user interface, and will respect the autoresponse settings in that action's Response Options tab on its manage page. For example, if you're POSTing to an event that has the autoresponse email turned on and you include the autoresponse trigger, the activist will get an autoresponse email as normal, thanking them for taking action. If you're POSTing to an event with the autoresponse turned off, they won't get that email.

Finally, you can POST to this helper without an API key. This is useful to enable a javascript implementation, say the use of a custom form that you create, without leaking your API key to browsers. If you use unauthenticated or "blind" POST without an API key, the response will be essentially no information, to avoid leaking any personal data over the API without an API key present. You will receive a success status code and an empty JSON response if successful, or an error status code and an error message if not. See the blind post tutorial for an example.

Note: Submissions are deduplicated based on person, so a specific person can only submit to a form once.

Sections:

Endpoint

Endpoint:

https://actionnetwork.org/api/v2/forms/[form_id]/submissions

The record submission helper lives at the endpoint relating to the collection of submissions on a specific form.

Back To Top ↑

Field names and descriptions

Record Submission Helper fields:
Field Name Type Required on POST Description
identifiers strings[] An array of identifiers in the format [system name]:[id]. Must be globally unique. See the general concepts document for more information about identifiers.
action_network:referrer_data Referrer Data A hash of referrer data such as source code and referrer code. Action Network-only.
person Person* Yes A hash representing person data to associate with this submission. You can use any valid fields for person resources. An email address is required. See the people document for more information about people. (The person's language preference will be set to the language of the action as specified in the action's user interface.)
add_tags strings[] An array of strings representing tags to add to the person's record.
triggers Triggers* A hash of triggers to be acted upon when the submission is created.
Referrer Data fields:
Field Name Type Required on POST Description
source string The source code of this submission. Equivalent to someone taking action with the url argument ?source=[your source]. Corresponds to the sources chart in this action's manage page. Action Network-only.
referrer string The referrer code of this submission. Equivalent to someone taking action with the url argument ?referrer=[your referrer code]. Must be a valid Action Network referrer code. Read-only. Corresponds to the referrers chart in this action's manage page. Action Network-only.
website string The website referrer for this submission. Equivalent to someone taking action after clicking a link on the listed website. Corresponds to the websites chart in this action's manage page. Action Network-only.
Triggers fields:
Field Name Type Required on POST Description
autoresponse Autoresponse* A hash of autoresponse information to be triggered when this submission is created.
Autoresponse fields:
Field Name Type Required on POST Description
enabled boolean Indicates whether an autoresponse email should be sent or not. If true, an autoresponse will be sent according to the settings of this form's response options.
Back To Top ↑

Related resources

Back To Top ↑

Scenario: Creating a new submission (POST)

If you post with an inline person hash instead of with a link to a person object as described here, we will create or update the matching person and associate them with a new submission on the specified form, all in one API call.

An email address is the only required field, though others can be POSTed.

People are matched and deduplicated by email address. If a new person is created as part of a POST operation, that person will be subscribed to the email list associated with your API key. If the email address is found, that person's subscription status (subscribed, unsubscribed, etc...) will not be changed unless you pass subscribed in the status field, as described in the people documentation. In that case, the person will be subscribed to the list, even if they were previously unsubscribed. No other status fields are valid on this endpoint.

Either way, submissions are deduplicated by person, so a person can only submit a form once. Posting a new submission by a person who previously submitted the form will replace the old submission resource with the new one.

Tags can also be added to a person's record when POSTing using the helper by including the optional tags array. Items in the array are matched to existing tags associated with the list matching your API key by name. If a matching tag is found, that tag will be added to the person's record. If not, the tag will be ignored.

And an optional triggers object can be added, indicating an autoresponse email should be sent back to the activist, which typically thanks them for taking action. Autoresponse emails are only sent from actions created with our user interface, and will respect the action's response options settings.

Finally, you can POST to this helper without an API key. This is useful to enable a javascript implementation, say the use of a custom form that you create, without leaking your API key to browsers. See the blind post tutorial for an example.

Here is an example of posting a submission with person data inlined to the special record_submission_helper link on the submission collection, along with tags and an autoresponse:

Request

						
POST https://actionnetwork.org/api/v2/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/

Header:
Content-Type: application/json
OSDI-API-Token: your_api_key_here
						

{
  "identifiers": [
    "free_forms:2"
  ],
  "person" : {
    "family_name" : "Smith",
    "given_name" : "John",
    "postal_addresses" : [ { "postal_code" : "20009" }],
    "email_addresses" : [ { "address" : "jsmith@mail.com" }]
  },
  "add_tags": [
    "volunteer",
    "member"
  ],
  "triggers": {
    "autoresponse": {
      "enabled": true
    }
  }
} 
					

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


{
  "identifiers": [
    "free_forms:2",
    "action_network:c449e8cd-0a81-42d1-91f7-47cacf33dbe4"
  ],
  "created_date": "2014-03-27T14:05:44Z",
  "modified_date": "2014-03-27T14:05:44Z",
  "action:person_id": "17be9a36-bb9a-4f68-94a8-40523b9dab27",
  "action_network:form_id": "adb951cb-51f9-420e-b7e6-de953195ec86",
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v2/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/c449e8cd-0a81-42d1-91f7-47cacf33dbe4"
    },
    "osdi:form": {
      "href": "https://actionnetwork.org/api/v2/forms/adb951cb-51f9-420e-b7e6-de953195ec86"
    },
    "osdi:person": {
      "href": "https://actionnetwork.org/api/v2/people/17be9a36-bb9a-4f68-94a8-40523b9dab27"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      }
    ]
  }
}
					

In the above example, a new person was created and their submission added to the form at the same time. The tags "volunteer" and "member" were added to that person's record as well. They received an autoresponse email from the action, according to its response option settings in the user interface. We deduplicate people added this way by email address, so if the email posted corresponded with a person already in the system, we would update their record instead of creating a new person. The required fields for person remain the same -- email address -- and any posts missing that information will fail.

If the person is new, they will be subscribed to the list associated with your API key. If not, their subscription status (subscribed, unsubscribed, etc...) will not be changed unless you pass subscribed in the status field, as described in the people documentation. In that case, they will be subscribed to the list, even if they were previously unsubscribed. No other status fields are valid on this endpoint.

Of course you can POST a submission with more fields such as address lines for your inline person data or custom fields if you'd like, but they are not required. And you can omit your API key, in which case the response will a success status code and an empty JSON object if successful, or an error code and message if not.

Back To Top ↑