This endpoint allows you to list campaigns in your account.

Listing Campaigns

A GET returns the campaigns, listing the most recently created campaigns first.

• uuid - the UUID of the campaign (string), filterable as uuid.
• name - the name of the campaign (string).
• archived - whether this campaign is archived (boolean)
• group - the group this campaign operates on (object).
• created_on - when the campaign was created (datetime), filterable as before and after.

Example:

GET /api/v2/campaigns.json

Response is a list of the campaigns on your account

{
    "next": null,
    "previous": null,
    "results": [
    {
        "uuid": "f14e4ff0-724d-43fe-a953-1d16aefd1c00",
        "name": "Reminders",
        "archived": false,
        "group": {"uuid": "7ae473e8-f1b5-4998-bd9c-eb8e28c92fa9", "name": "Reporters"},
        "created_on": "2013-08-19T19:11:21.088Z"
    },
    ...
}

Adding Campaigns

A POST can be used to create a new campaign, by sending the following data. Don't specify a UUID as this will be generated for you.

• name - the name of the campaign (string, required)
• group - the UUID of the contact group this campaign will be run against (string, required)

Example:

POST /api/v2/campaigns.json
{
    "name": "Reminders",
    "group": "7ae473e8-f1b5-4998-bd9c-eb8e28c92fa9"
}

You will receive a campaign object as a response if successful:

{
    "uuid": "f14e4ff0-724d-43fe-a953-1d16aefd1c00",
    "name": "Reminders",
    "archived": false,
    "group": {"uuid": "7ae473e8-f1b5-4998-bd9c-eb8e28c92fa9", "name": "Reporters"},
    "created_on": "2013-08-19T19:11:21.088Z"
}

Updating Campaigns

A POST can also be used to update an existing campaign if you specify its UUID in the URL.

Example:

POST /api/v2/campaigns.json?uuid=f14e4ff0-724d-43fe-a953-1d16aefd1c00
{
    "name": "Reminders II",
    "group": "7ae473e8-f1b5-4998-bd9c-eb8e28c92fa9"
}