We're making a request to an offsite domain, and when I making a PUT request to the offsite server via $.ajax, it looks as if the authenticity token is being concatenated to the end of the stringified JSON object - this obviously causes problems when our offsite server attempts to parse the JSON object, it finds a "&authenticity_token=..." which is not valid JSON.

It looks as if the check of how the authenticity token should be appended (I snooped around a bit in the minified liquid files) is a bit naive. Yes, we're sending up JSON, but best practice (http://stackoverflow.com/a/12693986 <http://stackoverflow.com/a/12693986>) is to stringify with $.ajax first. The authenticity token attachment logic incorrectly interprets the stringified JSON to be a query string.

I have solved this for the most part by preventing this event handler from firing by including the 'global:false;' option in the AJAX request. Thanks!

Is it possible to search for people by precinct? I'd like to use the API to find all people in a given precinct, so that I can build a strikethrough system for election day. 

Thanks

Is it possible to get the custom name and abbreviation that someone has assigned to the (political/social) capital feature?

For example, if someone has changed "Political Capital" to "My Community Points" ("MCP"), we want to use that as the label when displaying capital_amount_in_cents. Displaying "Political Capital" generically could confuse people in many cases.

I have already used PUT people/:id/taggings api for that. But it is giving me response Bad Request Your browser sent a request that this server could not understand. [code] => 411 [content_type] => text/html )

It has been reported that the Anedot integration does not send donation information with invalid emails through to NationBuilder. If a donor mis-types their email address (such as .con or .ney), the information will not be sent through and there is no indication of which transactions were not synced with NationBuilder. This makes NationBuilder donation records inaccurate.

We have received reports that users may find it helpful to list all people on a specific step within a specific path using our API. Currently, we offer the ability to index paths and search people, but not the ability to search people on a specific path or step.

It seems that the data that we get when we pull through the API is different than the data that you get when you just download a CSV file from a nation. The result is that the lists we pull from your API had about 20% duplicates. 

The "updated_at" field is not included in exports initiated via the Export List endpoint;  "created_at" is included. Could "updated_at" be added please?

Hi all,

is it possible to check if the user has control panel access via the API? Perhaps also with their access level? Maybe using the /api/v1/people/me endpoint? Thanks!

According to the API Authentication Quick Start Guide, I should be able to generate an Oauth client ID/secret for my nation via Settings > Apps > New App. However, I only see options for "Install new app" and "Installed apps". The former shows a list of 3rd-party apps, but no option to create a new one. Am I looking in the wrong place?

Hi folks,

I want to use the surveys to let canvassers add extra details while they are contacting people using an app I am designing. Right now I am getting a list of surveys by hitting /api/v1/sites/:site_slug/pages/surveys

However, this only includes surveys that have a corresponding page made for them, so the user must first make a survey and *then* add it to a page on a site. Not the easiest!

Is it possible to just provide an endpoint that lists all surveys without requiring them to be on a page first?

Thanks!

What format is the "date" used in searches on the updated_since field in the people search endpont?

What is the granularity of the comparison, is it just a comparison of the date or is it really a combarison with the updated_at field of the record, which appears to have a resolution of 1s?

An example of using this api call might be useful.

The content you can install in a page is inserted in the body of the page. It would be helpful if it was also possible to insert content into the head of the page, perhaps via an optional 'head' payload, in addition to the 'content' payload.

My use case is that I want to insert CSS as internal styles i.e. <style> ... </style> which can only be inserted in the head of the page. Note I need functionality that can't be deployed using inline styles (i.e. using the HTML style attribute).

When making an API call to an invalid endpoint the response returns the HTML from a 404 page. A response body describing the issue (endpoint does not exist, nation does not exist) along with a 404 status would be preferred for debugging issues.

Example:

[17] pry(main)> NationBuilder::Client.new("foo", "bar").call(:donations, :index)

NationBuilder::ClientError: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">



<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">



<head>

  <meta http-equiv="content-type" content="text/html; charset=UTF-8" />

  <title>404 Error: The page you were looking for doesn't exist</title>

<style type="text/css">

body {

        background: url(http://nationbuilder.s3.amazonaws.com/assets/404-grass.jpg) repeat top left;

        color: #fff;

        font-family: Lucida Grande, Lucida Sans Unicode, Garuda, sans-serif;

        margin: 15px 0;

        font-size: 1em;

}

#wrapper {

        padding: 15px 0 0 45px;

}

#headline {

         font-size: 2em;

        font-weight: bold;

        text-shadow: -1px -1px #333;

        color: yellow;

}

#description {

        font-size: 1.3em;

        line-height: 1.8em;

        color: #fff;

        text-shadow: -1px -1px #333;

}

#footer {

        clear: both;

        font-size: 0.8em;

}

a:link, a:active, a:visited {

        color: #ec7c31;

        text-decoration: none;

}

a:hover {

        text-decoration: none;

        background-color: #fee34c;

        color: #000;

}

#road {

  margin-top: 15px;

}

</style>

</head>



<body>

  <!-- This file lives in public/404.html -->



<div id="road">



<div id="wrapper">

<div id="headline">We couldn't find the page you were looking for.</div>

<div id="description">You may have mistyped the address or the page may have moved.</div>

</div>

<div id="road"><img src="http://nationbuilder.s3.amazonaws.com/assets/404-road.png" width="952" height="404"></div>

</div>



</body>

</html>

from [...]/gems/nationbuilder-rb-1.5.0/lib/nationbuilder/client.rb:129:in `parse_response_body'

It would be great to see the ability via the API to get any existing relationships a person has and add new ones, as you can do via the GUI.

Hi all, do you know how can I use the API to get the same list of people that appear under "Contacted By" on the data entry sheet?

I'm working on a data entry app and would like to have similar functionality to be able to choose who contacted a person. Thanks!

Right now the Donations Index endpoints returns all donations in a nation. It would be great if the API allowed the donor ID to be specified and then only return donations that have been made by that person.

In the GUI I can restrict access to a page, for example pages can be restricted to control panel users. However, I can't see any way of doing that via the Basic Pages API. Am I missing something?

The background is that I am writing an app that will periodically sync a Nation with an external database. I thought a good way to provide feedback on the operation of the app would be to populate a basic page on the Nation with status information. I would prefer that the page was only accessable by control panel users. Any other ideas?

- Andrew

Whenever we assign a membership to a person through API, it always shows "Dues amount" as "Free" under "Memberships" tab ("Edit" > "Memberships") on the person's profile. Is there a way to link a donation to the membership or just show an amount instead of "Free"?

Is there a way to assign point people through the API? All our lists are populated and kept up-to-date programmatically so we'd need to fit point-person assignments in this flow.

This would be very powerful for a bunch of existing integrations as well as new ones. For example, it would enable a service like CallHub to support members signing petitions via SMS. It would enable email your MP tools to track against petition pages directly within NationBuilder. It would also enable tools to report on a nation's core activities and track successes across a great range of actions.

Ideally, it would allow developers of external tools to work with NationBuilder's petitions as well as petition signatures, in the same way that we can already work with events and RSVPs (that event resource provides the best analogy).

I would say the key components would be:

1. Index endpoint (to return all petitions per site)
2. Create endpoint (create a new petition)
3. Show/update/delete endpoints (these are less important to us, but useful all the same :)
4. Petition signature Count endpoint (return the number of people who have signed a given petition)
5. Petition signature Index endpoint (return the NationBuilder IDs, first names and emails of everyone who has signed a given petition)
6. Petition signature Create endpoint (add a new signatory to a given petition)

Thanks for considering!

With the current People API you can add a note to a person's profile which is great! However, it would be fantastic if you could also get those notes too via the API.

At the moment, you can GET people/search with geographical filters City and State. It would be nice to able to also filter (for instance) on Address 1, or Street Number, Name, and Type, or ZIP. (ie. we would like to see more geographical / primary address filters exposed through the API.)

The create import endpoint does not offer the option to "Bypass webhooks" that is available when you perform a manual import.

1. Do imports initiated by via this endpoint the relevant webhooks (ie Person Created and Person Changed)?
2. Whatever the response to (1) it would be useful to control this behaviour from the API as it is via the manual interface.

Hi folks, we'd like to add some JS actions—adding content to fields—to an NationBuilder form on submit before the form validation/send is triggered. However binding on the form submit handler triggers after the NationBuilder actions and the data is not captured.

Is there an elegant/sanctioned way to hook into the event dispatcher? Essentially I need a callback before the form submits though NationBuilder XHR channels. Someone has a gist of how to do this, but the timing of this isn't correct (form still submits).

Hello. We're unable to import an CSV via the Import API, or update users via the People api when they have a name with a non-ascii character.

For example, if we post this JSON to the People API: 

{
"person": {
"email": "[email protected]",
"last_name": "José",
"first_name": "Böb",
"sex": "M",
"signup_type": 0,
"employer": "Dexter Labs",
"party": "P",
"registered_address": {
"state": "TX",
"country_code": "US"
}
}
}

we receive a 400 Bad Request response. Can you please advise?

We are using the donation API and are sending 'recruiter_name_or_email' through our integration to log who the fundraiser of a specific donation is. This data doesn't seem to be entering our nation even though the 'recruiter_name_or_email' field is a writable field.

For cron jobs or similar we need Nationbuilder to extend it's Oauth2 model to include Resource owner credentials grant

I have imported a number of records via the API, which all have an email address and email_opt_in='Y', but the
records are being imported as PROSPECTS. Whereas http://nationbuilder.com/how_support_status_is_determined says:

"Records imported with:

  * support level = 1
  * support level = 2
  * email address and email opt-in = Y
  * mobile number and mobile opt-in = Y

will always be supporters."

I want to add/delete a bunch of tags from a bunch of people. This involves multiple sequences along the lines

• Create temporary list
• Add people to list
• Add tags to people in list / remove tags from people in list
• Delete list

The documentation for the add tag endpoint says:

Use this endpoint to apply a tag to the people contained in a list. Note: this endpoint returns a HTTP 204 status code, but the tag is not applied immediately. For larger lists, this operation takes many minutes.

The remove tags endpoint is similar. So when is it safe to delete the list?

I want to add/delete a bunch of tags from a bunch of people. This involves multiple sequences along the lines

• Create temporary list
• Add people to list
• Add tags to people in list / remove tags from people in list
• Delete list

The documentation for the add tag endpoint says:

Use this endpoint to apply a tag to the people contained in a list. Note: this endpoint returns a HTTP 204 status code, but the tag is not applied immediately. For larger lists, this operation takes many minutes.

The remove tags endpoint is similar. So when is it safe to delete the list?

I've just come across some unexpected behaviour.

When using the people update API to update a precinct_code, e.g. with the payload:

{'person': {'precinct_name': 'Burton Bradstock'}}

I received a "400 Bad Request" with the response

{"code":"validation_failed","message":"Validation Failed.","validation_errors":["email '[email protected]' should look like an email address"]}

The same thing happened with imports that didn't involve email addresses failing because of email validation errors.

I have a need to integrate my Nation with an external system also hosted by us (on the same domain as our nation). The external system has user records and its own authentication. The external ids of these records are also present in our Nation.

What I really want is that when a user signs in to the external system they also sign in to our nation - i.e. I want a shared signon, but I cannot see any practical way of doing so.

Is there any avenue I can follow towards making this happen at all?

http://nationbuilder.com/surveys_api

Copying and pasting example code to create a survey generates a warning message. Adding an extra status - associated with the survey as opposed to the question it then works.

http://nationbuilder.com/surveys_api

I'm having problems with the bulk tag removal API. For example, using the API explorer for my nation I send the following:

DELETE | Bulk Tag Removal|

/people/:id/taggings with id = 123 and body:

{ "tagging": { "tag": ["hello"] } }

I get response code: 400 { "code":"missing_parameters","message":"Missing Parameters.","parameters":["tagging"]}

In contrast, the API for adding tags works as expected. This has exactly the same syntax except the request is a PUT not a DELETE.

In order to ensure the security/privacy of our supporter information we'd like to see a daily report on how third party apps have used the API and/or the ability to restrict apps to read or write. 

There is nothing stopping an app that pushes information to our nation also downloading our entire database without us being aware. Supporters trust us with their personal information so we'd like to ensure we keep it safe.

We are trying to hit the following API

token.post('/api/v1/donations', headers: {"Content-Type"=>"application/json", "Accept"=>"application/json"}, body: {:donation=>{:donor_id=>1234, :amount_in_cents=>1000, :payment_type_name=>"Other", :tracking_code_slug=>"", :succeeded_at=>Wed, 07 Sep 2016 23:18:32 EDT -04:00}})

When I hit the search endpoint for a name, for example, I have to use the exact name to return a result. For example, if I search for first_name=brad it won't return results for 'Bradley'. 

In addition, searching for names of organizations doesn't return results at all.

Webhooks don't seem to be firing for person created and changed webhooks. Possibly other events that trigger webhooks are also effected.

There appears to be inconsistencies between what is required/validated via the GUI, and what is required/validated via the API.

For example, via the GUI you can create and edit an event that has no location. However, trying to edit one of these events via the API will produce a validation error, as location is required.

This results in needing to add code such as this to all my event editing script:

contact = event["contact"]
contact["name"] = "Default Contact Name" if contact["name"].nil? || contact["name"].empty?
contact["email"] = "[email protected]" if contact["email"].nil? || contact["email"].empty?if !event["venue"].nil? && !event["venue"]["address"].nil?


address = event["venue"]["address"]
  address["city"] = "Unknown" if address["city"].nil? || address["city"].empty?
end

api/v1/sites returns 'null' for domains for all sites, regardless of if the site has a domain set.

new to NB, but trying to make something work on my 'nation' and this is one way i typically learn a new code base.  wazzup?

I think a new method is needed to list a nations custom fields and their types. For instance by only being able to view a custom field on a person I am unable to tell the difference between a text and a multiple choice field.

Also I am unable to infer the possible options for a multiple choice field if there is no person with that option. 

There is some issue with “Delete People Endpoint” in “List API”( http://nationbuilder.com/lists_api ). It always returns 400 error with the message that says:

{"code":"missing_parameters","message":"Missing Parameters.","parameters":["people_ids"]} 

I'm calling the Person Create endpoint, and receiving back a good response with json reflecting the new user.  But Newtonsoft.Json is returning an error when attempting to deserialize the Json to a NationBuilderAPI.V1.PersonResponse<NationBuilderAPI.V1.Person>.  Has there been an update to the Person Create endpoint that's not reflected in the C# API?  I'm using version NationbuilderAPI version 1.3 from Nuget.

It would be great if this were possible! 

Hi, 

It would be a huge help if paths and steps were included in the API.  Then we could automate much more of the importing and tracking that we do.  The feature has been out for a while and it seems intuitive that the feature would be included in the API.  Thanks so much!

Jenny Landon

Represent.Us

When I install Field Edge it doesn't appear in Installed Apps or in the app listing. This makes me concerned it's not installed. 

I would think that many others would have had to migrate from Wordpress or Drupal to Nationbuilder by this point, but I can't seem to find many resources.

Seeing as there is no way to batch import posts I created a script to do so, and categorize them under their respective parent blog within Nationbuilder- attaching an 'external_id'.

So now, to update these same posts (content authors have made edits on old site during NB development) I have to first make a GET request to /sites/:site_slug/pages/blogs/:id/match to get the external id, then another UPDATE request to /sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id .

Is there was an UPDATE or DELETE by 'external_id' method available or in the works? Many developers will be migrating to Nationbuilder and these functions alone will make the migration process easier- and open the doors to CSV batch editing for larger sites.