Grassroots Supporter Action

The endpoint for actions taken by your Contacts through the Action Center(s).

Retrieve multiple Grassroots Supporter Actions based on search critera passed as GET Arguments

get/api/supporteraction/

The endpoint for actions taken by your Contacts through the Action Center(s).

Securityapi_key and user_name
Request
query Parameters
action_center_id
integer <int64>

The actioncentersettings with which this grassrootssupporteraction is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
action_center__in - The value for the record is in the provided array parameter (comma-separated values).
action_center__isnull - The value for the record is null (if true) or is not null.

amount
integer <int64>

A nonnegative transaction account, in the smallest denomination, assummed to be USD cents

NOTE: Parameter accepts additional qualifiers appended to the end:
amount__in - The value for the record is in the provided array parameter (comma-separated values).
amount__gt, amount__gte, amount__lt, amount__lte - The value for the record is greater than/less than (or equal to) the provided parameter.
amount__isnull - The value for the record is null (if true) or is not null.

archived
boolean

Whether the record has been soft-deleted or not.

bulk_email_id
integer <int64>

The bulkemail with which this grassrootssupporteraction is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
bulk_email__in - The value for the record is in the provided array parameter (comma-separated values).
bulk_email__isnull - The value for the record is null (if true) or is not null.

campaign_id
integer <int64>

The campaign this supporter action is associated with
NOTE: This related object is outside of the scope of our documentation.recommended you contact us at integrations@quorum.us before building anything that relies upon it.

NOTE: Parameter accepts additional qualifiers appended to the end:
campaign__in - The value for the record is in the provided array parameter (comma-separated values).
campaign__isnull - The value for the record is null (if true) or is not null.

confirmed
boolean

Whether or not the action has been confirmed in a campaign requiring approval

created
string <date-time>

When the record was originally created.

NOTE: Parameter accepts additional qualifiers appended to the end:
created__year, created__month, created__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

date
string <date-time>

The date that the supporter action took place

NOTE: Parameter accepts additional qualifiers appended to the end:
date__year, date__month, date__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

from_grassroots
boolean

Indicator if the action is inlvolved in grassroots. Holdover from Note model

id
integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

interaction_type
integer <int64>

Interaction type for the action. Required for all actions to help build inlines

NOTE: Parameter accepts additional qualifiers appended to the end:
interaction_type__in - The value for the record is in the provided array parameter (comma-separated values).
interaction_type__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name GrassrootsInteractionType, for an explanation of values.

Enum: 1 3 4 6 7 11 21 25 26 27 28 29 30 31 34 35 36 37 43 44 45 46 48 49 50 51 52 85 104 105 106 107 108 109
note_type
integer <int64>

Note type for the action. Should all be interactions

NOTE: Parameter accepts additional qualifiers appended to the end:
note_type__in - The value for the record is in the provided array parameter (comma-separated values).
note_type__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name NoteType, for an explanation of values.

Enum: 1 2 3
organization_id
integer <int64>

The organization that the supporter action is taking an action for

NOTE: Parameter accepts additional qualifiers appended to the end:
organization__in - The value for the record is in the provided array parameter (comma-separated values).
organization__isnull - The value for the record is null (if true) or is not null.

payroll_frequency_type
integer <int64>

Payroll frequency for payroll contributions

NOTE: Parameter accepts additional qualifiers appended to the end:
payroll_frequency_type__in - The value for the record is in the provided array parameter (comma-separated values).
payroll_frequency_type__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name PayrollFrequencyType, for an explanation of values.

Enum: 1 3 4 5
person_id
integer <int64>

The person who the message is targeted for

NOTE: Parameter accepts additional qualifiers appended to the end:
person__in - The value for the record is in the provided array parameter (comma-separated values).
person__isnull - The value for the record is null (if true) or is not null.

projects
Array of integers <int64>

The projects this supporter action is associated with. It can be associated with multiple projects

NOTE: Parameter accepts additional qualifiers appended to the end:
projects__overlaps - The value for the record has one or more values in common with the provided array parameter (comma-separated values).

social_media_type
integer <int64>

The type of social media being shared on Shared campaigns

NOTE: Parameter accepts additional qualifiers appended to the end:
social_media_type__in - The value for the record is in the provided array parameter (comma-separated values).
social_media_type__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name SocialMediaType, for an explanation of values.

Enum: 1 2 3 4 5
source_type
integer <int64>

Our best guess as to the source of a particular thing, whether internal to Quorum, a particular website, etc.

NOTE: Parameter accepts additional qualifiers appended to the end:
source_type__in - The value for the record is in the provided array parameter (comma-separated values).

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name UTMSourceType, for an explanation of values.

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
submitting_org_name
string

If this is a comment regulation campaign, this the name of the organization

NOTE: Parameter accepts additional qualifiers appended to the end:
submitting_org_name__in - The value for the record is in the provided array parameter (comma-separated values).
submitting_org_name__contains, submitting_org_name__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
submitting_org_name__startswith, submitting_org_name__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
submitting_org_name__endswith, submitting_org_name__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
submitting_org_name__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
submitting_org_name__isnull - The value for the record is null (if true) or is not null.

supporter_id
integer <int64>

The supporter who owns this supporter action

NOTE: Parameter accepts additional qualifiers appended to the end:
supporter__in - The value for the record is in the provided array parameter (comma-separated values).

transaction_method_type
integer <int64>

The Type of method - credit card, ach transfer, etc

NOTE: Parameter accepts additional qualifiers appended to the end:
transaction_method_type__in - The value for the record is in the provided array parameter (comma-separated values).
transaction_method_type__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name TransactionMethodType, for an explanation of values.

Enum: 1 2 3 4 5 6 7 8 9 10 11 12
updated
string <date-time>

When the record was most recently updated.

NOTE: Parameter accepts additional qualifiers appended to the end:
updated__year, updated__month, updated__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

dehydrate_extra
Array of strings

Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values.campaign - expand campaign with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Value: "campaign"
advanced_search
string

Perform an advanced text search on the datset with the provided text. This search will use the most comprehensive search method available on the requested endpoint, but can take slightly longer to return results.

limit
integer <int64>
Default: 20

The number of records to return (for pagination).

offset
integer <int64>
Default: 0

The number of records to offset the start of the data being returned (for pagination).

Responses
200

GrassrootsSupporterAction retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "action_center": "/api/actioncentersettings/1/",
  • "amount": 0,
  • "archived": true,
  • "audit_trail": { },
  • "bulk_email": "/api/bulkemail/1/",
  • "cache_json": { },
  • "call_duration": 0,
  • "campaign": "/api/campaign/1/",
  • "clicks": 0,
  • "confirmed": true,
  • "created": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": true,
  • "delivered_timestamp": "2019-08-24T14:15:22Z",
  • "delivery_id": "string",
  • "failed_delivery": true,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": true,
  • "http_referer": "string",
  • "humanized_text": "string",
  • "id": 0,
  • "interaction_type": 1,
  • "link_dict": { },
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "payroll_frequency_type": 1,
  • "person": "/api/newperson/1/",
  • "points_earned": 0,
  • "projects": [
    ],
  • "raw_content": "string",
  • "regions": [
    ],
  • "resource_uri": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "text": "string",
  • "timestamp": { },
  • "transaction_method_type": 1,
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string"
}

Retrieve information on a single Grassroots Supporter Action

get/api/supporteraction/{id}/

The endpoint for actions taken by your Contacts through the Action Center(s).

Securityapi_key and user_name
Request
path Parameters
id
required
integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

query Parameters
dehydrate_extra
Array of strings

Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values.campaign - expand campaign with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Value: "campaign"
Responses
200

GrassrootsSupporterAction retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "action_center": "/api/actioncentersettings/1/",
  • "amount": 0,
  • "archived": true,
  • "audit_trail": { },
  • "bulk_email": "/api/bulkemail/1/",
  • "cache_json": { },
  • "call_duration": 0,
  • "campaign": "/api/campaign/1/",
  • "clicks": 0,
  • "confirmed": true,
  • "created": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": true,
  • "delivered_timestamp": "2019-08-24T14:15:22Z",
  • "delivery_id": "string",
  • "failed_delivery": true,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": true,
  • "http_referer": "string",
  • "humanized_text": "string",
  • "id": 0,
  • "interaction_type": 1,
  • "link_dict": { },
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "payroll_frequency_type": 1,
  • "person": "/api/newperson/1/",
  • "points_earned": 0,
  • "projects": [
    ],
  • "raw_content": "string",
  • "regions": [
    ],
  • "resource_uri": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "text": "string",
  • "timestamp": { },
  • "transaction_method_type": 1,
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string"
}

Update a single Grassroots Supporter Action by ID

patch/api/supporteraction/{id}/

The endpoint for actions taken by your Contacts through the Action Center(s).

Securityapi_key and user_name
Request
path Parameters
id
required
integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

Request Body schema: application/json
archived
boolean

Whether the record has been soft-deleted or not.

confirmed
boolean

Whether or not the action has been confirmed in a campaign requiring approval

date
string <date-time>

The date that the supporter action took place

person_id
string <{"id": QUORUM_ID}>

The person who the message is targeted for
The argument provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

points_earned
integer <int64>

Amount of points a supporter earned from this action

projects
Array of strings <{"id": QUORUM_ID}>

The projects this supporter action is associated with. It can be associated with multiple projects
Each item provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: [{"id": 410003}, {"id": 410014}]

supporter_id
string <{"id": QUORUM_ID}>

The supporter who owns this supporter action
The argument provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

text
string

The text body of the message

user_id
string <{"id": QUORUM_ID}>

The user associated with the action
NOTE: This related object is outside of the scope of our documentation.recommended you contact us at integrations@quorum.us before building anything that relies upon it.

The argument provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

Responses
200

GrassrootsSupporterAction retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "archived": true,
  • "confirmed": true,
  • "date": "2019-08-24T14:15:22Z",
  • "person_id": "string",
  • "points_earned": 0,
  • "projects": [
    ],
  • "supporter_id": "string",
  • "text": "string",
  • "user_id": "string"
}
Response samples
application/json
{
  • "_extra": { },
  • "action_center": "/api/actioncentersettings/1/",
  • "amount": 0,
  • "archived": true,
  • "audit_trail": { },
  • "bulk_email": "/api/bulkemail/1/",
  • "cache_json": { },
  • "call_duration": 0,
  • "campaign": "/api/campaign/1/",
  • "clicks": 0,
  • "confirmed": true,
  • "created": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": true,
  • "delivered_timestamp": "2019-08-24T14:15:22Z",
  • "delivery_id": "string",
  • "failed_delivery": true,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": true,
  • "http_referer": "string",
  • "humanized_text": "string",
  • "id": 0,
  • "interaction_type": 1,
  • "link_dict": { },
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "payroll_frequency_type": 1,
  • "person": "/api/newperson/1/",
  • "points_earned": 0,
  • "projects": [
    ],
  • "raw_content": "string",
  • "regions": [
    ],
  • "resource_uri": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "text": "string",
  • "timestamp": { },
  • "transaction_method_type": 1,
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string"
}

Create a single Grassroots Supporter Action

post/api/supporteraction/{id}/

The endpoint for actions taken by your Contacts through the Action Center(s).

Securityapi_key and user_name
Request
path Parameters
id
required
integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

Request Body schema: application/json
archived
boolean

Whether the record has been soft-deleted or not.

confirmed
boolean

Whether or not the action has been confirmed in a campaign requiring approval

date
string <date-time>

The date that the supporter action took place

person_id
string <{"id": QUORUM_ID}>

The person who the message is targeted for
The argument provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

points_earned
integer <int64>

Amount of points a supporter earned from this action

projects
Array of strings <{"id": QUORUM_ID}>

The projects this supporter action is associated with. It can be associated with multiple projects
Each item provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: [{"id": 410003}, {"id": 410014}]

supporter_id
string <{"id": QUORUM_ID}>

The supporter who owns this supporter action
The argument provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

text
string

The text body of the message

user_id
string <{"id": QUORUM_ID}>

The user associated with the action
NOTE: This related object is outside of the scope of our documentation.recommended you contact us at integrations@quorum.us before building anything that relies upon it.

The argument provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

Responses
200

GrassrootsSupporterAction retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "archived": true,
  • "confirmed": true,
  • "date": "2019-08-24T14:15:22Z",
  • "person_id": "string",
  • "points_earned": 0,
  • "projects": [
    ],
  • "supporter_id": "string",
  • "text": "string",
  • "user_id": "string"
}
Response samples
application/json
{
  • "_extra": { },
  • "action_center": "/api/actioncentersettings/1/",
  • "amount": 0,
  • "archived": true,
  • "audit_trail": { },
  • "bulk_email": "/api/bulkemail/1/",
  • "cache_json": { },
  • "call_duration": 0,
  • "campaign": "/api/campaign/1/",
  • "clicks": 0,
  • "confirmed": true,
  • "created": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": true,
  • "delivered_timestamp": "2019-08-24T14:15:22Z",
  • "delivery_id": "string",
  • "failed_delivery": true,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": true,
  • "http_referer": "string",
  • "humanized_text": "string",
  • "id": 0,
  • "interaction_type": 1,
  • "link_dict": { },
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "payroll_frequency_type": 1,
  • "person": "/api/newperson/1/",
  • "points_earned": 0,
  • "projects": [
    ],
  • "raw_content": "string",
  • "regions": [
    ],
  • "resource_uri": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "text": "string",
  • "timestamp": { },
  • "transaction_method_type": 1,
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string"
}