Advocacy Campaigns Version 2

This document describes the OSDI advocacy campaigns collection and advocacy campaign resource as implemented by the Action Network.

Advocacy campaigns are a type of action created by the organizer or group associated with your API key that involves activists writing letters or making calls to their elected officials or other targets. They correspond to the letter campaign and call campaign tools on our UI.

Advocacy campaigns have names (corresponding to our administrative titles), titles, and can have descriptions and other fields, and when activists submit them outreach resources are created representing the letter an activist sent to an official.

Advocacy campaigns are not deduplicated except on identifiers, to keep identifiers unique. Identifiers are deduplicated globally, across groups and API keys, so ensure any you set are globally unique.

Note: Advocacy campaigns created via the API are not equivalent to advocacy campaigns created with our user interface. API-created advocacy campaigns will not show up in lists of all of your actions on your dashboard of group page, they will not be given a URL on actionnetwork.org where people can take action, they will not have individual manage pages for statistics and submission downloads, they will not send autoresponses, and outreaches POSTed to them will not deliver messages to targets. Rather, once they have at least one outreach, they will show up as actions available for selection in our targeting interface, allowing you to select all people who have taken action on that advocacy campaign for reports or email targeting.

Sections:

Endpoints and URL structures

Endpoints:

https://actionnetwork.org/api/v2/advocacy_campaigns

Advocacy campaign resources live exclusively at the above endpoint. The endpoint returns a collection of all the advocacy campaigns associated with your API key.

URL Structures:

https://actionnetwork.org/api/v2/advocacy_campaigns/[id]

To address a specific form, use their identifier without the action_network: prefix to construct a URL, like https://actionnetwork.org/api/v2/advocacy_campaigns/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3

Back To Top ↑

Field names and descriptions

Advocacy Campaign 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.
origin_system string Yes A human readable string identifying where this advocacy campaign originated. May be used in the user interface for this purpose.
created_date datetime The date and time the resource was created. System generated, not editable.
modified_date datetime The date and time the resource was last modified. System generated, not editable.
name string The advocacy campaign's administrative title, only shown internally and not publicly.
title string Yes The advocacy campaign's public title.
description string The advocacy campaign's description. May contain HTML. Not present for call campaigns that are not click to call.
targets string The target universe for this advocacy campaign. (ex: 'U.S. Congress')
browser_url string The URL to this advocacy campaign on the Action Network. Only present for letter campaigns and click to call campaigns created with our user interface. Not editable.
featured_image_url string The URL to this action's featured image on the Action Network, if a banner image has been set. Only present for letter campaigns and click to call campaigns created with our user interface. Not editable.
total_outreaches integer A system generated count of the number of outreaches on this advocacy campaign. Not editable.
type string The type of advocacy campaign, specifying how users perform outreaches to targets. Can be
action_network:hidden boolean A read-only field indicating whether this action is hidden in our user interface or not.
osdi:creator Person* An embedded person representing the user who created this advocacy campaign. If you do not assign a creator, we will assign one based on your API key. Cannot be edited once created.
action_network:sponsor Sponsor A hash of the sponsoring group of this advocacy campaign. Action Network-only feature. Automatically added if you post using a group API key. System generated, not editable.
Sponsor fields:
Field Name Type Required on POST Description
title string The name of the sponsoring group.
browser_url string The URL to the group's public page.
Back To Top ↑

Links

Link Name Description
self A link to this individual advocacy campaign resource.
osdi:outreaches A link to a collection of all outreach resources associated with this advocacy campaign. Click here for outreaches documentation.
osdi:creator A link to the person who created this advocacy campaign. Click here for people documentation.
action_network:embed A link to embed code for this advocacy campaign. Only present for letter campaigns created with our user interface. Action Network-only feature. Click here for embed documentation.
osdi:record_outreach_helper A link to the record outreach helper for this advocacy campaign. Click here for the record outreach helper documentation.
Back To Top ↑

Related resources

Back To Top ↑

Scenario: Retrieving a collection of advocacy campaign resources (GET)

Advocacy campaign resources are sometimes presented as collections of advocacy campaigns. For example, calling the advocacy campaigns endpoint will return a collection of all the advocacy campaigns associated with your API key.

Request

						
GET https://actionnetwork.org/api/v2/advocacy_campaigns/

Header:
OSDI-API-Token: your_api_key_here

Response

						
200 OK

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


{
  "total_pages": 10,
  "per_page": 25,
  "page": 1,
  "total_records": 250,
  "_links": {
    "next": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns?page=2"
    },
    "self": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns"
    },
    "osdi:advocacy_campaigns": [
      {
        "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/65345d7d-cd24-466a-a698-4a7686ef684f"
      },
      {
        "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86"
      },
      //truncated for brevity
    ],
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      }
    ]
  },
  "_embedded": {
    "osdi:advocacy_campaigns": [
      {
        "origin_system": "FreeAdvocacy.com",
        "identifiers": [
          "action_network:65345d7d-cd24-466a-a698-4a7686ef684f",
          "free_forms:1"
        ],
        "created_date": "2014-03-25T14:40:07Z",
        "modified_date": "2014-03-25T14:47:44Z",
        "title": "Tell your Senator to stop the bad thing!",
        "targets": "U.S. Senate",
        "type": "email",
        "total_outreaches": 25,
        "action_network:hidden": false,
        "_embedded": {
          "osdi:creator": {
            "given_name": "John",
            "family_name": "Doe",
            "identifiers": [
              "action_network:c945d6fe-929e-11e3-a2e9-12313d316c29"
            ],
            "created_date": "2014-03-24T18:03:45Z",
            "modified_date": "2014-03-25T15:00:22Z",
            "email_addresses": [
              {
                "primary": true,
                "address": "jdoe@mail.com",
                "status": "subscribed"
              }
            ],
            "phone_numbers": [
              {
              "primary": true,
              "number": "12021234444",
              "number_type": "Mobile",
              "status": "subscribed"
              }
            ],
            "postal_addresses": [
              {
                "primary": true,
                "address_lines": [
                  "1600 Pennsylvania Ave"
                ],
                "locality": "Washington",
                "region": "DC",
                "postal_code": "20009",
                "country": "US",
                "language": "en",
                "location": {
                  "latitude": 32.935,
                  "longitude": -73.1338,
                  "accuracy": "Approximate"
                }
              }
            ],
            "languages_spoken": [
              "en"
            ],
            "_links": {
              "self": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
              },
              "osdi:attendances": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances"
              },
              "osdi:signatures": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/signatures"
              },
              "osdi:submissions": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/submissions"
              },
              "osdi:donations": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/donations"
              },
              "osdi:outreaches": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/outreaches"
              },
              "osdi:taggings": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/taggings"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/65345d7d-cd24-466a-a698-4a7686ef684f"
          },
          "osdi:outreaches": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/65345d7d-cd24-466a-a698-4a7686ef684f/outreaches"
          },
          "osdi:record_outreach_helper": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/65345d7d-cd24-466a-a698-4a7686ef684f/outreaches"
          },
          "osdi:creator": {
            "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
          },
          "action_network:embed": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/65345d7d-cd24-466a-a698-4a7686ef684f/embed"
          }
        }
      },
      {
        "identifiers": [
          "action_network:adb951cb-51f9-420e-b7e6-de953195ec86"
        ],
        "created_date": "2014-03-21T23:39:53Z",
        "modified_date": "2014-03-25T15:26:45Z",
        "title": "Thank Acme's CEO for going green",
        "description": "<p>Write a letter today!</p>",
        "browser_url": "https://actionnetwork.org/letters/thanks-acme",
        "featured_image_url": "https://actionnetwork.org/images/acme.jpg",
        "targets": "Acme CEO",
        "type": "email",
        "total_outreaches": 6,
        "action_network:hidden": false,
        "_embedded": {
          "osdi:creator": {
            "given_name": "John",
            "family_name": "Doe",
            "identifiers": [
              "action_network:c945d6fe-929e-11e3-a2e9-12313d316c29"
            ],
            "created_date": "2014-03-24T18:03:45Z",
            "modified_date": "2014-03-25T15:00:22Z",
            "email_addresses": [
              {
                "primary": true,
                "address": "jdoe@mail.com",
                "status": "subscribed"
              }
            ],
            "phone_numbers": [
              {
                "primary": true,
                "number": "12021234444",
                "number_type": "Mobile",
                "status": "subscribed"
              }
             ],
            "postal_addresses": [
              {
                "primary": true,
                "address_lines": [
                  "1600 Pennsylvania Ave."
                ],
                "locality": "Washington",
                "region": "DC",
                "postal_code": "20009",
                "country": "US",
                "language": "en",
                "location": {
                  "latitude": 32.934,
                  "longitude": -74.5319,
                  "accuracy": "Approximate"
                }
              }
            ],
            "languages_spoken": [
              "en"
            ],
            "_links": {
              "self": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
              },
              "osdi:attendances": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances"
              },
              "osdi:signatures": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/signatures"
              },
              "osdi:submissions": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/submissions"
              },
              "osdi:donations": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/donations"
              },
              "osdi:outreaches": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/outreaches"
              },
              "osdi:taggings": {
                "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/taggings"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86"
          },
          "osdi:outreaches": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86/outreaches"
          },
          "osdi:record_outreach_helper": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86/outreaches"
          },
          "osdi:creator": {
            "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
          },
          "action_network:embed": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86/embed"
          }
        }
      },
      {
        "created_date": "2021-01-06T21:02:39Z",
        "modified_date": "2021-01-11T19:34:59Z",
        "identifiers": [
          "action_network:44618be7-29cb-439e-bc68-70e6e85dda1b"
        ],
        "origin_system": "Action Network",
        "name": "Call your elected officials",
        "title": "Call your elected officials",
        "type": "phone",
        "total_outreaches": 9,
        "action_network:sponsor": {
          "title": "Progressive Action Now"
        },
        "action_network:hidden": false,
        "_links": {
          "curies": [
            {
              "name": "osdi",
              "href": "https://actionnetwork.org/docs/v2/{rel}",
              "templated": true
            },
            {
              "name": "action_network",
              "href": "https://actionnetwork.org/docs/v2/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/44618be7-29cb-439e-bc68-70e6e85dda1b"
          },
          "osdi:outreaches": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/44618be7-29cb-439e-bc68-70e6e85dda1b/outreaches"
          },
          "osdi:creator": {
            "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
          },
          "osdi:record_outreach_helper": {
            "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/44618be7-29cb-439e-bc68-70e6e85dda1b/outreaches"
          }
        }
      },
      //truncated for brevity
    ]
  }
}
Back To Top ↑

Scenario: Retrieving an individual advocacy campaign resource (GET)

Calling an individual advocacy campaign resource will return the resource directly, along with all associated fields and appropriate links to additional information about the advocacy campaign.

Request

						
GET https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86

Header:
OSDI-API-Token: your_api_key_here

Response

						
200 OK

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


{
  "identifiers": [
    "action_network:adb951cb-51f9-420e-b7e6-de953195ec86"
  ],
  "created_date": "2014-03-21T23:39:53Z",
  "modified_date": "2014-03-25T15:26:45Z",
  "title": "Thank Acme's CEO for going green",
  "description": "<p>Write a letter today!</p>",
  "browser_url": "https://actionnetwork.org/letters/thanks-acme",
  "featured_image_url": "https://actionnetwork.org/images/acme.jpg",
  "targets": "Acme CEO",
  "type": "email",
  "total_outreaches": 6,
  "action_network:hidden": false,
  "_embedded": {
    "osdi:creator": {
      "given_name": "John",
      "family_name": "Doe",
      "identifiers": [
        "action_network:c945d6fe-929e-11e3-a2e9-12313d316c29"
      ],
      "created_date": "2014-03-24T18:03:45Z",
      "modified_date": "2014-03-25T15:00:22Z",
      "email_addresses": [
        {
          "primary": true,
          "address": "jdoe@mail.com",
          "status": "subscribed"
        }
      ],
      "phone_numbers": [
        {
          "primary": true,
          "number": "12021234444",
          "number_type": "Mobile",
          "status": "subscribed"
        }
      ],
      "postal_addresses": [
        {
          "primary": true,
          "address_lines": [
            "1600 Pennsylvania Ave"
          ],
          "locality": "Washington",
          "region": "DC",
          "postal_code": "20009",
          "country": "US",
          "language": "en",
          "location": {
            "latitude": 32.934,
            "longitude": -72.0377,
            "accuracy": "Approximate"
          }
        }
      ],
      "languages_spoken": [
        "en"
      ],
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:attendances": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances"
        },
        "osdi:signatures": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/signatures"
        },
        "osdi:submissions": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/submissions"
        },
        "osdi:donations": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/donations"
        },
        "osdi:outreaches": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/outreaches"
        },
        "osdi:taggings": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/taggings"
        },
        "curies": [
          {
            "name": "osdi",
            "href": "https://actionnetwork.org/docs/v2/{rel}",
            "templated": true
          },
          {
            "name": "action_network",
            "href": "https://actionnetwork.org/docs/v2/{rel}",
            "templated": true
          }
        ]
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86"
    },
    "osdi:outreaches": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86/outreaches"
    },
    "osdi:record_outreach_helper": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86/outreaches"
    },
    "osdi:creator": {
      "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
    },
    "action_network:embed": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/adb951cb-51f9-420e-b7e6-de953195ec86/embed"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      }
    ]
  }
}
Back To Top ↑

Scenario: Creating a new advocacy campaign (POST)

You can post a new advocacy campaign to the advocacy campaigns endpoint and an advocacy campaign resource will be created in our system.

Note: Advocacy campaigns created via the API in this way are not equivalent to advocacy campaigns created with our user interface. API-created advocacy campaigns will not show up in lists of all of your actions on your dashboard of group page, they will not be given a URL on actionnetwork.org where people can take action, they will not have individual manage pages for statistics and submission downloads, they will not send autoresponses, and outreaches POSTed to them will not deliver messages to targets. Rather, once they have at least one outreach, they will show up as actions available for selection in our targeting interface, allowing you to select all people who have taken action on that advocacy campaign for reports or email targeting.

In the targeting interface, they will show up in the format [1, (origin system) Letter Campaign], (title). For example, an advocacy campaign with the origin system 'FreeAdvocacy.com' and the title 'My Free Advocacy Campaign' will show up in the targeting interface as [1, FreeAdvocacy.com Letter Campaign], My Free Advocacy Campaign so you can easily identify what it is and where it came from when doing your targeting.

Request

						
POST https://actionnetwork.org/api/v2/advocacy_campaigns

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

{	
  "title": "My Free Advocacy Campaign",
  "origin_system": "FreeAdvocacy.com",
  "type": "email"
}

Response

						
200 OK

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


{
  "origin_system": "FreeAdvocacy.com",
  "identifiers": [
    "action_network:d8fff9ec-78a4-4c3d-a724-d4bb751abfbb"
  ],
  "created_date": "2014-03-26T21:52:07Z",
  "modified_date": "2014-03-26T21:52:07Z",
  "title": "My Free Advocacy Campaign",
  "type": "email",
  "total_outreaches": 0,
  "action_network:hidden": false,
  "_embedded": {
    "osdi:creator": {
      "given_name": "John",
      "family_name": "Doe",
      "identifiers": [
        "action_network:c945d6fe-929e-11e3-a2e9-12313d316c29"
      ],
      "created_date": "2014-03-24T18:03:45Z",
      "modified_date": "2014-03-25T15:00:22Z",
      "email_addresses": [
        {
          "primary": true,
          "address": "jdoe@mail.com",
          "status": "subscribed"
        }
      ],
      "phone_numbers": [
        {
          "primary": true,
          "number": "12021234444",
          "number_type": "Mobile",
          "status": "subscribed"
        }
      ],
      "postal_addresses": [
        {
          "primary": true,
          "address_lines": [
            "1600 Pennsylvania Ave"
          ],
          "locality": "Washington",
          "region": "DC",
          "postal_code": "20009",
          "country": "US",
          "language": "en",
          "location": {
            "latitude": 32.935,
            "longitude": -56.0377,
            "accuracy": "Approximate"
          }
        }
      ],
      "languages_spoken": [
        "en"
      ],
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:attendances": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances"
        },
        "osdi:signatures": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/signatures"
        },
        "osdi:submissions": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/submissions"
        },
        "osdi:donations": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/donations"
        },
        "osdi:outreaches": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/outreaches"
        },
        "osdi:taggings": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/taggings"
        },
        "curies": [
          {
            "name": "osdi",
            "href": "https://actionnetwork.org/docs/v2/{rel}",
            "templated": true
          },
          {
            "name": "action_network",
            "href": "https://actionnetwork.org/docs/v2/{rel}",
            "templated": true
          }
        ]
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb"
    },
    "osdi:outreaches": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb/outreaches"
    },
    "osdi:record_outreach_helper": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb/outreaches"
    },
    "osdi:creator": {
      "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
    },
    "action_network:embed": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb/embed"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      }
    ]
  }
}

You can post an advocacy campaign with a creator link as well, if you want to assign the advocacy campaign to a specific Action Network user, like so:

						
POST https://actionnetwork.org/api/v2/advocacy_campaigns

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

{	
  "title": "My Free Advocacy Campaign",
  "origin_system": "FreeAdvocacy.com",
  "_links" : {
    "osdi:creator" : { 
      "href" : "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29" 
    }
  }
}

The link must be a valid person resource and must be associated with your API key for it to be accepted. If your API key is for an individual account, then the link must be to your account's person resource. If your API key is for a group, then the link must be to a member of administrator of your group. If no link or an invalid link is provided, the advocacy campaign will be assigned to your API key's account person record or to the original creator of the group, whichever is appropriate. If a creator is explicitly set, people who take action will be added to that creator's personal email list. Otherwise, the creator is has no effect on what email list people who take action on the advocacy campaign are subscribed to.

And of course you can post an advocacy campaign with more fields (such as description) if you'd like, but they are not required.

Back To Top ↑

Scenario: Modifying an advocacy campaign (PUT)

You can modify an existing advocacy campaign by using PUT on its individual endpoint.

Request

						
PUT https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb

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

{	
  "title": "My Free Advocacy Campaign With A New Name",
  "description": "This is my free advocacy campaign description"
}

Response

						
200 OK

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


{
  "origin_system": "FreeAdvocacy.com",
  "identifiers": [
    "action_network:d8fff9ec-78a4-4c3d-a724-d4bb751abfbb",
  ],
  "created_date": "2014-03-26T21:52:07Z",
  "modified_date": "2014-03-26T21:54:28Z",
  "title": "My Free Advocacy Campaign With A New Name",
  "description": "This is my free advocacy campaign description",
  "type": "email",
  "total_outreaches": 0,
  "action_network:hidden": false,
  "_embedded": {
    "osdi:creator": {
      "given_name": "John",
      "family_name": "Doe",
      "identifiers": [
        "action_network:c945d6fe-929e-11e3-a2e9-12313d316c29"
      ],
      "created_date": "2014-03-24T18:03:45Z",
      "modified_date": "2014-03-25T15:00:22Z",
      "email_addresses": [
        {
          "primary": true,
          "address": "jdoe@mail.com",
          "status": "subscribed"
        }
      ],
      "phone_numbers": [
        {
          "primary": true,
          "number": "12021234444",
          "number_type": "Mobile",
          "status": "subscribed"
        }
      ],
      "postal_addresses": [
        {
          "primary": true,
          "address_lines": [
            "1600 Pennsylvania Ave"
          ],
          "locality": "Washington",
          "region": "DC",
          "postal_code": "20009",
          "country": "US",
          "language": "en",
          "location": {
            "latitude": 32.416,
            "longitude": -75.0672,
            "accuracy": "Approximate"
          }
        }
      ],
      "languages_spoken": [
        "en"
      ],
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
        },
        "osdi:attendances": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/attendances"
        },
        "osdi:signatures": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/signatures"
        },
        "osdi:submissions": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/submissions"
        },
        "osdi:donations": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/donations"
        },
        "osdi:outreaches": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/outreaches"
        },
        "osdi:taggings": {
          "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29/taggings"
        },
        "curies": [
          {
            "name": "osdi",
            "href": "https://actionnetwork.org/docs/v2/{rel}",
            "templated": true
          },
          {
            "name": "action_network",
            "href": "https://actionnetwork.org/docs/v2/{rel}",
            "templated": true
          }
        ]
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb"
    },
    "osdi:outreaches": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb/outreaches"
    },
    "osdi:record_outreach_helper": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb/outreaches"
    },
    "osdi:creator": {
      "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
    },
    "action_network:embed": {
      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns/d8fff9ec-78a4-4c3d-a724-d4bb751abfbb/embed"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      }
    ]
  }
}

The above example changed the title and added a description.

Editing of certain fields via PUT is not allowed, and is noted in the field names table above. For example, you can't change the total_outreaches count -- that is a system generated number reflecting a count of the underlying outreaches. And you can't change the creator of an advocacy campaign. Invalid entries will be ignored.

Back To Top ↑

Scenario: Deleting an advocacy campaign (DELETE)

Deleting advocacy campaigns is not allowed via the API. DELETE requests will return an error.

Back To Top ↑