Contacts

The endpoint for the Contacts dataset.

Retrieve multiple contacts based on search critera passed as GET Arguments

get/api/newsupporter/
Securityapi_key and user_name
Request
query Parameters
address_geocoded
boolean

Whether the string address has been geocoded into lat/lon pair.

archived
boolean

Whether the record has been soft-deleted or not.

congressional_district_id
integer <int64>

The district object for the U.S. House of Representatives district within which thisContact's geocoded primary address is located.
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:
congressional_district__in - The value for the record is in the provided array parameter (comma-separated values).
congressional_district__isnull - The value for the record is null (if true) or is not null.

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).

email
string

Primary Email Address for this Contact; this is the address available in Outbox to email this Contact.

NOTE: Parameter accepts additional qualifiers appended to the end:
email__in - The value for the record is in the provided array parameter (comma-separated values).
email__contains, email__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)
email__startswith, email__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
email__endswith, email__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)
email__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
email__isnull - The value for the record is null (if true) or is not null.

id
integer <int64>

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

is_grassroots_supporter
boolean

Whether this contact is someone who would advocate on your behalf (for User information, does not impact Quorum application)

NOTE: Parameter accepts additional qualifiers appended to the end:
is_grassroots_supporter__isnull - The value for the record is null (if true) or is not null.

is_stakeholder_supporter
boolean

Whether this contact is an influencer for your organization's public policy objectives. (for User information, does not impact Quorum application)

NOTE: Parameter accepts additional qualifiers appended to the end:
is_stakeholder_supporter__isnull - The value for the record is null (if true) or is not null.

members
Array of integers <int64>

The newpersons that are associated with this supporter.

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

name
string

Full Name

NOTE: Parameter accepts additional qualifiers appended to the end:
name__in - The value for the record is in the provided array parameter (comma-separated values).
name__contains, 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)
name__startswith, name__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
name__endswith, 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)
name__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
name__isnull - The value for the record is null (if true) or is not null.

postal_code
string

Postal code of primary address.

NOTE: Parameter accepts additional qualifiers appended to the end:
postal_code__in - The value for the record is in the provided array parameter (comma-separated values).
postal_code__contains, postal_code__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)
postal_code__startswith, postal_code__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
postal_code__endswith, postal_code__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)
postal_code__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
postal_code__isnull - The value for the record is null (if true) or is not null.

public_organization_id
integer <int64>

The organization associated with the Supporter.

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

region
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
region__in - The value for the record is in the provided array parameter (comma-separated values).
region__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 Region, 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 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 1000
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
state_id
integer <int64>

The State object in the Geography model for this Contact's Geocoded primary address.
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:
state__in - The value for the record is in the provided array parameter (comma-separated values).
state__isnull - The value for the record is null (if true) or is not null.

title
string

Title.

NOTE: Parameter accepts additional qualifiers appended to the end:
title__in - The value for the record is in the provided array parameter (comma-separated values).
title__contains, title__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)
title__startswith, title__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
title__endswith, title__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)
title__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
title__isnull - The value for the record is null (if true) or is not null.

unsubscribed_from_bulk_emails
boolean

Whether the contact is unsubscribed from your bulk emails.

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).

valid_email
boolean

When a contact is initially created in Quorum, the default value of "valid_email" is True. Accordingly, a better way to think about this field might be to invert it -- think of it as "invalid_email" where it would be initialized as false.

Upon initial save of a contact object, we run a basic pattern match on the email to see if it matches the RFC standard for emails: '([a-zA-Z0-9_.+-']+@(?:[a-zA-Z0-9_-]+.)+[a-zA-Z0-9_-.]+)$'. In plain English, this means that any set of letters, numbers, dots, plus signs, and dashes followed by an @ sign and then a valid domain is permissible. If an email fails this test, the contact is immediately set to valid_email=False. Blank or null strings do not currently fail this test as our sending logic requires both the presence of a not-null not-empty email and valid_email being set to True.

Once we send an email to this contact, we start receiving responses from that recipient's email server and use those responses to determine if an email should be set to invalid -- this is the primary reason why that might occur. Generally, sending multiple emails to a bad, old, or fake email is one of the easiest ways to get added to email block lists and hurt your overall domain reputation, so we follow email sending best practices and set this field to false anytime we receive a hard block or spam block from this email. To classify actions, we use the fields provided by our email partner, Sparkpost, available here: https://www.sparkpost.com/docs/deliverability/bounce-classification-codes/. If an email receives a bounce event in the classification "Hard", "Block", or "Admin", we will set valid_email to false and not email it again.

Should you wish to "reset" this field, you can either use Bulk Actions through the UI or a bulk upload to reset this field and try to email it again via Outbox. If we receive a further hard bounce from this email, we'll re-mark it as invalid; however, if your email is successfully delivered, you'll be able to continue emailing this person until you get another hard block of some kind.

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.

quick_search
string

Perform an quick text search on the datset with the provided text. This search method may, depending on the endpoint, be exactly identical to advanced search, or may return results significantly more quickly but with less completeness or accuracy, for example by searching less fields, or using a faster algorithm to identify matches that has a greater propensity for false positives/false negatives.

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

NewSupporter retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "activated": true,
  • "active": true,
  • "address": "string",
  • "address_geocoded": true,
  • "alert_cache": { },
  • "alternate_address": "string",
  • "archived": true,
  • "birthdate": "2019-08-24T14:15:22Z",
  • "bulk_email_unsubscribe_key": "string",
  • "cached_limited_to_teams": null,
  • "calculated_unsubscribed_from_texting": 0,
  • "city": "string",
  • "coordinates": "string",
  • "country_name": "string",
  • "county_name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "email_related_person": "/api/newperson/1/",
  • "employer": "string",
  • "extension": "string",
  • "facebook_array": [
    ],
  • "facebook_url_array": [
    ],
  • "fb_id": 0,
  • "firstname": "string",
  • "formatted_primary_phone": "string",
  • "formatted_secondary_phone": "string",
  • "has_ever_received_email_dn": true,
  • "has_participated_in_any_campaign_dn": true,
  • "has_shared_campaign_on_social_dn": true,
  • "http_referer": "string",
  • "icon": "string",
  • "id": 0,
  • "image_url": "string",
  • "input_address": "string",
  • "instagram_array": [
    ],
  • "is_grassroots_supporter": true,
  • "is_recently_active_email_recipient": true,
  • "is_stakeholder_supporter": true,
  • "last_user": "/api/user/1/",
  • "lastname": "string",
  • "latitude": 0,
  • "limited_to_teams": [
    ],
  • "longitude": 0,
  • "major_organization_types": null,
  • "medium_array": [
    ],
  • "middlename": "string",
  • "name": "string",
  • "pac_eligibilities": [
    ],
  • "phone_number": "string",
  • "postal_code": "string",
  • "postal_code_ext": "string",
  • "preferred_name": "string",
  • "prefix": "string",
  • "public_organization": "/api/publicorganization/1/",
  • "public_organization_name": "string",
  • "public_organization_names": "string",
  • "public_organizations": [
    ],
  • "region": 1,
  • "registered_with_text_keyword": "string",
  • "resource_uri": "string",
  • "secondary_email": "string",
  • "secondary_extension": "string",
  • "secondary_phone": "string",
  • "should_display_in_external_logger": true,
  • "source_type": 1,
  • "state_abbreviation": "string",
  • "state_name": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "stripe_customer_id": "string",
  • "suffix": "string",
  • "supporter_type": 1,
  • "tag_dict": { },
  • "title": "string",
  • "twitter_array": [
    ],
  • "unique_identifier": "string",
  • "unsubscribed_from_bulk_emails": true,
  • "unsubscribed_from_texting": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "valid_email": true,
  • "validated_address": true,
  • "waiting_to_be_created_by_user": true,
  • "website": "string",
  • "youtube_array": [
    ]
}

Retrieve information on a single Contact

get/api/newsupporter/{id}/

The endpoint for the Contacts dataset.

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.

Responses
200

NewSupporter retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "activated": true,
  • "active": true,
  • "address": "string",
  • "address_geocoded": true,
  • "alert_cache": { },
  • "alternate_address": "string",
  • "archived": true,
  • "birthdate": "2019-08-24T14:15:22Z",
  • "bulk_email_unsubscribe_key": "string",
  • "cached_limited_to_teams": null,
  • "calculated_unsubscribed_from_texting": 0,
  • "city": "string",
  • "coordinates": "string",
  • "country_name": "string",
  • "county_name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "email_related_person": "/api/newperson/1/",
  • "employer": "string",
  • "extension": "string",
  • "facebook_array": [
    ],
  • "facebook_url_array": [
    ],
  • "fb_id": 0,
  • "firstname": "string",
  • "formatted_primary_phone": "string",
  • "formatted_secondary_phone": "string",
  • "has_ever_received_email_dn": true,
  • "has_participated_in_any_campaign_dn": true,
  • "has_shared_campaign_on_social_dn": true,
  • "http_referer": "string",
  • "icon": "string",
  • "id": 0,
  • "image_url": "string",
  • "input_address": "string",
  • "instagram_array": [
    ],
  • "is_grassroots_supporter": true,
  • "is_recently_active_email_recipient": true,
  • "is_stakeholder_supporter": true,
  • "last_user": "/api/user/1/",
  • "lastname": "string",
  • "latitude": 0,
  • "limited_to_teams": [
    ],
  • "longitude": 0,
  • "major_organization_types": null,
  • "medium_array": [
    ],
  • "middlename": "string",
  • "name": "string",
  • "pac_eligibilities": [
    ],
  • "phone_number": "string",
  • "postal_code": "string",
  • "postal_code_ext": "string",
  • "preferred_name": "string",
  • "prefix": "string",
  • "public_organization": "/api/publicorganization/1/",
  • "public_organization_name": "string",
  • "public_organization_names": "string",
  • "public_organizations": [
    ],
  • "region": 1,
  • "registered_with_text_keyword": "string",
  • "resource_uri": "string",
  • "secondary_email": "string",
  • "secondary_extension": "string",
  • "secondary_phone": "string",
  • "should_display_in_external_logger": true,
  • "source_type": 1,
  • "state_abbreviation": "string",
  • "state_name": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "stripe_customer_id": "string",
  • "suffix": "string",
  • "supporter_type": 1,
  • "tag_dict": { },
  • "title": "string",
  • "twitter_array": [
    ],
  • "unique_identifier": "string",
  • "unsubscribed_from_bulk_emails": true,
  • "unsubscribed_from_texting": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "valid_email": true,
  • "validated_address": true,
  • "waiting_to_be_created_by_user": true,
  • "website": "string",
  • "youtube_array": [
    ]
}

Update a single Contacts by ID

patch/api/newsupporter/{id}/

The endpoint for the Contacts dataset.

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
address
string
alternate_address
string

Alternate address, user entered.

archived
boolean

Whether the record has been soft-deleted or not.

email
string

Primary Email Address for this Contact; this is the address available in Outbox to email this Contact.

employer
string

The employer of the contact, if applicable.

extension
string

Primary phone extension.

facebook_array
Array of strings

The id of this supporter's facebook account

firstname
string

First Name

image_url
string

Cached path of image url

input_address
string

The address as originally input / imported, prior to Geocoding

instagram_array
Array of strings
is_grassroots_supporter
boolean

Whether this contact is someone who would advocate on your behalf (for User information, does not impact Quorum application)

is_stakeholder_supporter
boolean

Whether this contact is an influencer for your organization's public policy objectives. (for User information, does not impact Quorum application)

last_user_id
string <{"id": QUORUM_ID}>

Quourm User ID of the last Quorum user that created/edited this Supporter in any way.
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}

lastname
string

Last Name

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

The teams that are associated with this supporter.

medium_array
Array of strings

The name of this supporter's medium account

middlename
string

Middle Name

name
string

Full Name

organization_id
string <{"id": QUORUM_ID}>

The Quorum Client Organization that owns this supporter record.
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}

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

The ledgersettingss that are associated with this supporter.

phone_number
string

Primary phone number.

preferred_name
string

Preferred name.

prefix
string

Prefix of a person's name, like Mr., Mrs., The Honorable, etc.

public_organization_id
string <{"id": QUORUM_ID}>

The organization associated with the Supporter.
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}

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

The publicorganizations that are associated with this supporter.

secondary_email
string

Secondary Email (personal etc.) assuming the first one is work/primary email

secondary_extension
string

Secondary phone extension.

secondary_phone
string

Secondary phone number.

should_display_in_external_logger
boolean

Display this contact in the organization's action center's external interaction/relationship logger

suffix
string

Suffix of a person's name, like III, Jr., etc.

tag_dict
string

Dictionary of custom field information, stored as Key/Value pairs.

title
string

Title.

twitter_array
Array of strings
unique_identifier
string

The organization-specific assigned unique identifier - Note that uniqueness is not enforced.

unsubscribed_from_bulk_emails
boolean

Whether the contact is unsubscribed from your bulk emails.

youtube_array
Array of strings

The name of the supporter's YouTube channel, if known.

Responses
200

NewSupporter retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "address": "string",
  • "alternate_address": "string",
  • "archived": true,
  • "email": "string",
  • "employer": "string",
  • "extension": "string",
  • "facebook_array": [
    ],
  • "firstname": "string",
  • "image_url": "string",
  • "input_address": "string",
  • "instagram_array": [
    ],
  • "is_grassroots_supporter": true,
  • "is_stakeholder_supporter": true,
  • "last_user_id": "string",
  • "lastname": "string",
  • "limited_to_teams": [
    ],
  • "medium_array": [
    ],
  • "middlename": "string",
  • "name": "string",
  • "organization_id": "string",
  • "pac_eligibilities": [
    ],
  • "phone_number": "string",
  • "preferred_name": "string",
  • "prefix": "string",
  • "public_organization_id": "string",
  • "public_organizations": [
    ],
  • "secondary_email": "string",
  • "secondary_extension": "string",
  • "secondary_phone": "string",
  • "should_display_in_external_logger": true,
  • "suffix": "string",
  • "tag_dict": "string",
  • "title": "string",
  • "twitter_array": [
    ],
  • "unique_identifier": "string",
  • "unsubscribed_from_bulk_emails": true,
  • "youtube_array": [
    ]
}
Response samples
application/json
{
  • "_extra": { },
  • "activated": true,
  • "active": true,
  • "address": "string",
  • "address_geocoded": true,
  • "alert_cache": { },
  • "alternate_address": "string",
  • "archived": true,
  • "birthdate": "2019-08-24T14:15:22Z",
  • "bulk_email_unsubscribe_key": "string",
  • "cached_limited_to_teams": null,
  • "calculated_unsubscribed_from_texting": 0,
  • "city": "string",
  • "coordinates": "string",
  • "country_name": "string",
  • "county_name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "email_related_person": "/api/newperson/1/",
  • "employer": "string",
  • "extension": "string",
  • "facebook_array": [
    ],
  • "facebook_url_array": [
    ],
  • "fb_id": 0,
  • "firstname": "string",
  • "formatted_primary_phone": "string",
  • "formatted_secondary_phone": "string",
  • "has_ever_received_email_dn": true,
  • "has_participated_in_any_campaign_dn": true,
  • "has_shared_campaign_on_social_dn": true,
  • "http_referer": "string",
  • "icon": "string",
  • "id": 0,
  • "image_url": "string",
  • "input_address": "string",
  • "instagram_array": [
    ],
  • "is_grassroots_supporter": true,
  • "is_recently_active_email_recipient": true,
  • "is_stakeholder_supporter": true,
  • "last_user": "/api/user/1/",
  • "lastname": "string",
  • "latitude": 0,
  • "limited_to_teams": [
    ],
  • "longitude": 0,
  • "major_organization_types": null,
  • "medium_array": [
    ],
  • "middlename": "string",
  • "name": "string",
  • "pac_eligibilities": [
    ],
  • "phone_number": "string",
  • "postal_code": "string",
  • "postal_code_ext": "string",
  • "preferred_name": "string",
  • "prefix": "string",
  • "public_organization": "/api/publicorganization/1/",
  • "public_organization_name": "string",
  • "public_organization_names": "string",
  • "public_organizations": [
    ],
  • "region": 1,
  • "registered_with_text_keyword": "string",
  • "resource_uri": "string",
  • "secondary_email": "string",
  • "secondary_extension": "string",
  • "secondary_phone": "string",
  • "should_display_in_external_logger": true,
  • "source_type": 1,
  • "state_abbreviation": "string",
  • "state_name": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "stripe_customer_id": "string",
  • "suffix": "string",
  • "supporter_type": 1,
  • "tag_dict": { },
  • "title": "string",
  • "twitter_array": [
    ],
  • "unique_identifier": "string",
  • "unsubscribed_from_bulk_emails": true,
  • "unsubscribed_from_texting": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "valid_email": true,
  • "validated_address": true,
  • "waiting_to_be_created_by_user": true,
  • "website": "string",
  • "youtube_array": [
    ]
}

Create a single Contacts

post/api/newsupporter/{id}/

The endpoint for the Contacts dataset.

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
address
string
alternate_address
string

Alternate address, user entered.

archived
boolean

Whether the record has been soft-deleted or not.

email
string

Primary Email Address for this Contact; this is the address available in Outbox to email this Contact.

employer
string

The employer of the contact, if applicable.

extension
string

Primary phone extension.

facebook_array
Array of strings

The id of this supporter's facebook account

firstname
string

First Name

image_url
string

Cached path of image url

input_address
string

The address as originally input / imported, prior to Geocoding

instagram_array
Array of strings
is_grassroots_supporter
boolean

Whether this contact is someone who would advocate on your behalf (for User information, does not impact Quorum application)

is_stakeholder_supporter
boolean

Whether this contact is an influencer for your organization's public policy objectives. (for User information, does not impact Quorum application)

last_user_id
string <{"id": QUORUM_ID}>

Quourm User ID of the last Quorum user that created/edited this Supporter in any way.
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}

lastname
string

Last Name

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

The teams that are associated with this supporter.

medium_array
Array of strings

The name of this supporter's medium account

middlename
string

Middle Name

name
string

Full Name

organization_id
string <{"id": QUORUM_ID}>

The Quorum Client Organization that owns this supporter record.
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}

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

The ledgersettingss that are associated with this supporter.

phone_number
string

Primary phone number.

preferred_name
string

Preferred name.

prefix
string

Prefix of a person's name, like Mr., Mrs., The Honorable, etc.

public_organization_id
string <{"id": QUORUM_ID}>

The organization associated with the Supporter.
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}

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

The publicorganizations that are associated with this supporter.

secondary_email
string

Secondary Email (personal etc.) assuming the first one is work/primary email

secondary_extension
string

Secondary phone extension.

secondary_phone
string

Secondary phone number.

should_display_in_external_logger
boolean

Display this contact in the organization's action center's external interaction/relationship logger

suffix
string

Suffix of a person's name, like III, Jr., etc.

tag_dict
string

Dictionary of custom field information, stored as Key/Value pairs.

title
string

Title.

twitter_array
Array of strings
unique_identifier
string

The organization-specific assigned unique identifier - Note that uniqueness is not enforced.

unsubscribed_from_bulk_emails
boolean

Whether the contact is unsubscribed from your bulk emails.

youtube_array
Array of strings

The name of the supporter's YouTube channel, if known.

Responses
200

NewSupporter retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "address": "string",
  • "alternate_address": "string",
  • "archived": true,
  • "email": "string",
  • "employer": "string",
  • "extension": "string",
  • "facebook_array": [
    ],
  • "firstname": "string",
  • "image_url": "string",
  • "input_address": "string",
  • "instagram_array": [
    ],
  • "is_grassroots_supporter": true,
  • "is_stakeholder_supporter": true,
  • "last_user_id": "string",
  • "lastname": "string",
  • "limited_to_teams": [
    ],
  • "medium_array": [
    ],
  • "middlename": "string",
  • "name": "string",
  • "organization_id": "string",
  • "pac_eligibilities": [
    ],
  • "phone_number": "string",
  • "preferred_name": "string",
  • "prefix": "string",
  • "public_organization_id": "string",
  • "public_organizations": [
    ],
  • "secondary_email": "string",
  • "secondary_extension": "string",
  • "secondary_phone": "string",
  • "should_display_in_external_logger": true,
  • "suffix": "string",
  • "tag_dict": "string",
  • "title": "string",
  • "twitter_array": [
    ],
  • "unique_identifier": "string",
  • "unsubscribed_from_bulk_emails": true,
  • "youtube_array": [
    ]
}
Response samples
application/json
{
  • "_extra": { },
  • "activated": true,
  • "active": true,
  • "address": "string",
  • "address_geocoded": true,
  • "alert_cache": { },
  • "alternate_address": "string",
  • "archived": true,
  • "birthdate": "2019-08-24T14:15:22Z",
  • "bulk_email_unsubscribe_key": "string",
  • "cached_limited_to_teams": null,
  • "calculated_unsubscribed_from_texting": 0,
  • "city": "string",
  • "coordinates": "string",
  • "country_name": "string",
  • "county_name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
  • "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "email_related_person": "/api/newperson/1/",
  • "employer": "string",
  • "extension": "string",
  • "facebook_array": [
    ],
  • "facebook_url_array": [
    ],
  • "fb_id": 0,
  • "firstname": "string",
  • "formatted_primary_phone": "string",
  • "formatted_secondary_phone": "string",
  • "has_ever_received_email_dn": true,
  • "has_participated_in_any_campaign_dn": true,
  • "has_shared_campaign_on_social_dn": true,
  • "http_referer": "string",
  • "icon": "string",
  • "id": 0,
  • "image_url": "string",
  • "input_address": "string",
  • "instagram_array": [
    ],
  • "is_grassroots_supporter": true,
  • "is_recently_active_email_recipient": true,
  • "is_stakeholder_supporter": true,
  • "last_user": "/api/user/1/",
  • "lastname": "string",
  • "latitude": 0,
  • "limited_to_teams": [
    ],
  • "longitude": 0,
  • "major_organization_types": null,
  • "medium_array": [
    ],
  • "middlename": "string",
  • "name": "string",
  • "pac_eligibilities": [
    ],
  • "phone_number": "string",
  • "postal_code": "string",
  • "postal_code_ext": "string",
  • "preferred_name": "string",
  • "prefix": "string",
  • "public_organization": "/api/publicorganization/1/",
  • "public_organization_name": "string",
  • "public_organization_names": "string",
  • "public_organizations": [
    ],
  • "region": 1,
  • "registered_with_text_keyword": "string",
  • "resource_uri": "string",
  • "secondary_email": "string",
  • "secondary_extension": "string",
  • "secondary_phone": "string",
  • "should_display_in_external_logger": true,
  • "source_type": 1,
  • "state_abbreviation": "string",
  • "state_name": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "stripe_customer_id": "string",
  • "suffix": "string",
  • "supporter_type": 1,
  • "tag_dict": { },
  • "title": "string",
  • "twitter_array": [
    ],
  • "unique_identifier": "string",
  • "unsubscribed_from_bulk_emails": true,
  • "unsubscribed_from_texting": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "valid_email": true,
  • "validated_address": true,
  • "waiting_to_be_created_by_user": true,
  • "website": "string",
  • "youtube_array": [
    ]
}