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:

PropertyTypeDescription
targetIdintUnique identifier for a Target.
namestringThe name given to the Target when it was created.
typestringCan be Static or Dynamic. Static Targets are based on Saved Lists and Dynamic Targets are based on Saved Searches.
descriptionstringThe description given to the Target when it was created.
pointsintThe number of points used by a Target.
areSubgroupsStickyboolIndicates that any contact that meets the criteria of a Subgroup will remain in that Subgroup and not be reassigned based on new data.
statusstringCan 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.
subgroupsarrayAn array of Subgroup objects.

Subgroup

Each Subgroup has the following properties:

PropertyTypeDescription
fullNameintThe long name for the Subgroup.
namestringThe medium name for the Subgroup.
subgroupIdintUnique identifier for a Subgroup.
isAssociatedWithBadgesboolIndicates whether the Subgroup name is displayed on the contact record in the UI.