Common Models

The following is an example of a Campaign and associated Content.

{
    "campaignId": 7919,
    "name": "Increase the Minimum Wage",
    "campaignType": {
        "campaignTypeId": 1312,
        "name": "Advocacy"
    },
    "campaignDisplayName": "Advocacy: Increase the Minimum Wage",
    "status": "Active",
    "contents": [
        {
            "contentId": 5328,
            "contentType": {
                "contentTypeId": 1861,
                "name": "Literature"
            },
            "name": "Pro Minimum Wage",
            "shortName": "Pro Wage",
            "displayName": "Literature: Pro Minimum Wage",
            "description": "This is a lit piece encouraging minimum wage increases",
            "disposition": "Positive"
        },
        {
            "contentId": 5329,
            "contentType": {
                "contentTypeId": 1861,
                "name": "Literature"
            },
            "name": "Anti Minimum Wage",
            "shortName": "Anti Wage",
            "displayName": "Literature: Anti Minimum Wage",
            "description": null,
            "disposition": "Negative"
        }
    ]
}

Campaign

Each Campaign can have the following properties:

Property	Type	Description
`campaignId`	int	Read-only; Unique identifier for a Campaign in this context
`name`	string	Name of the Campaign
`campaignType`	object	Type of Campaign
`campaignDisplayName`	string	The name of the Campaign combined with the Campaign Type
`status`	string	One of `Active`, `Archived`, or `Inactive`
`contents`	array	Array of Contents

Campaign Type

Property	Type	Description
`campaignTypeId`	int	Read-only; unique identifier for a Campaign Type in this context
`name`	string	Name of the Campaign Type

Contents represent distinct messages delivered as part of a campaign. For example, you may have a Content for each direct mail piece you send.

Property	Type	Description
`contentId`	int	Read-only; unique identifier for a Content in this context
`contentType`	object	Content Type of this Content
`name`	string	Name of this Content
`shortName`	string	A shorter name for this Content
`displayName`	string	The name of the Content combined with the Content Type
`description`	string	Description of this content
`disposition`	string	One of `Positive` or `Negative`; this indicates whether this particular Content makes a positive or negative argument

Content Type

Property	Type	Description
`contentTypeId`	int	Read-only; unique identifier for a Content Type in this context
`name`	string	Name of this Content Type