Common Models

The following is an example of a Target:

{
  "targetId": 33,
  "name": "GOTV Targets",
  "type": "Dynamic",
  "description": null,
  "points": 5,
  "areSubgroupsSticky": false,
  "status": "Ready",
  "subgroups": [
    {
      "fullName": "Excellent Voters",
      "name": "Excellent",
      "subgroupId": 123,
      "isAssociatedWithBadges": false
    },
    {
      "fullName": "Warm Voters",
      "name": "Warm",
      "subgroupId": 456,
      "isAssociatedWithBadges": false
    }
  ]
}

Target

Each Target has the following properties:

Property	Type	Description
`targetId`	int	Unique identifier for a Target.
`name`	string	The name given to the Target when it was created.
`type`	string	Can be `Static` or `Dynamic`. `Static` Targets are based on Saved Lists and `Dynamic` Targets are based on Saved Searches.
`description`	string	The description given to the Target when it was created.
`points`	int	The number of points used by a Target.
`areSubgroupsSticky`	bool	Indicates that any contact that meets the criteria of a Subgroup will remain in that Subgroup and not be reassigned based on new data.
`status`	string	Can be one of `Setup`, `Ready`, or `Active`. `Setup` means the `Target` is in the configuration process. `Ready` indicates that the Target is ready to be run in the nightly update. `Active` indicates that the Target has completed at least one nightly run.
`subgroups`	array	An array of Subgroup objects.

Subgroup

Each Subgroup has the following properties:

Property	Type	Description
`fullName`	int	The long name for the Subgroup.
`name`	string	The medium name for the Subgroup.
`subgroupId`	int	Unique identifier for a Subgroup.
`isAssociatedWithBadges`	bool	Indicates whether the Subgroup name is displayed on the contact record in the UI.