OpenField (1.0.0)

Download OpenAPI specification:Download

OpenField Open API V1 Documentation + schema.

address-details

listAddressDetails

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

createAddressDetail

Request Body schema:
address_vf_id
string or null <= 100 characters
usps_line_of_travel
string or null <= 5 characters
usps_line_of_travel_order
string or null <= 4 characters
usps_carrier_route
string or null <= 100 characters
address_type
string or null <= 100 characters
usps_address_type
string or null <= 100 characters
is_seasonal
boolean or null
is_po_box
boolean or null
is_bad
boolean or null
is_mailable
string or null <= 100 characters
is_walkable
boolean or null
address
integer

Responses

Request samples

Content type
{
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

addressTypesAddressDetail

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

retrieveAddressDetail

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

updateAddressDetail

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
address_vf_id
string or null <= 100 characters
usps_line_of_travel
string or null <= 5 characters
usps_line_of_travel_order
string or null <= 4 characters
usps_carrier_route
string or null <= 100 characters
address_type
string or null <= 100 characters
usps_address_type
string or null <= 100 characters
is_seasonal
boolean or null
is_po_box
boolean or null
is_bad
boolean or null
is_mailable
string or null <= 100 characters
is_walkable
boolean or null
address
integer

Responses

Request samples

Content type
{
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

partialUpdateAddressDetail

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
address_vf_id
string or null <= 100 characters
usps_line_of_travel
string or null <= 5 characters
usps_line_of_travel_order
string or null <= 4 characters
usps_carrier_route
string or null <= 100 characters
address_type
string or null <= 100 characters
usps_address_type
string or null <= 100 characters
is_seasonal
boolean or null
is_po_box
boolean or null
is_bad
boolean or null
is_mailable
string or null <= 100 characters
is_walkable
boolean or null
address
integer

Responses

Request samples

Content type
{
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

destroyAddressDetail

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

bulkUpsertAddressDetail

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
address_vf_id
string or null <= 100 characters
usps_line_of_travel
string or null <= 5 characters
usps_line_of_travel_order
string or null <= 4 characters
usps_carrier_route
string or null <= 100 characters
address_type
string or null <= 100 characters
usps_address_type
string or null <= 100 characters
is_seasonal
boolean or null
is_po_box
boolean or null
is_bad
boolean or null
is_mailable
string or null <= 100 characters
is_walkable
boolean or null
address
integer

Responses

Request samples

Content type
{
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_vf_id": "string",
  • "usps_line_of_travel": "strin",
  • "usps_line_of_travel_order": "stri",
  • "usps_carrier_route": "string",
  • "address_type": "string",
  • "usps_address_type": "string",
  • "is_seasonal": true,
  • "is_po_box": true,
  • "is_bad": true,
  • "is_mailable": "string",
  • "is_walkable": true,
  • "address": 0
}

contact-batches

listContactBatchs

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

owner
string

owner

conversation_code
string

conversation_code

completed
string

completed

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

createContactBatch

Request Body schema:
conversation_code
required
integer
contact_matches
required
Array of integers
owner
required
integer
completed
boolean

Responses

Request samples

Content type
{
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

retrieveContactBatch

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

owner
string

owner

conversation_code
string

conversation_code

completed
string

completed

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

updateContactBatch

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

owner
string

owner

conversation_code
string

conversation_code

completed
string

completed

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
conversation_code
required
integer
contact_matches
required
Array of integers
owner
required
integer
completed
boolean

Responses

Request samples

Content type
{
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

partialUpdateContactBatch

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

owner
string

owner

conversation_code
string

conversation_code

completed
string

completed

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
conversation_code
required
integer
contact_matches
required
Array of integers
owner
required
integer
completed
boolean

Responses

Request samples

Content type
{
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

destroyContactBatch

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

owner
string

owner

conversation_code
string

conversation_code

completed
string

completed

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

bulkUpsertContactBatch

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
conversation_code
required
integer
contact_matches
required
Array of integers
owner
required
integer
completed
boolean

Responses

Request samples

Content type
{
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "conversation_code": 0,
  • "contact_matches": [
    ],
  • "owner": 0,
  • "completed": true
}

contact-matches

listContactMatchs

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

batch
string

batch

batch__isnull
string

batch__isnull

provider
string
Enum: "facebook" "twitter" "google" "apple"

provider

provider__isnull
string

provider__isnull

contact
string

contact

contact__isnull
string

contact__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

createContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

Request Body schema:
batch
integer or null
contact
required
integer
provider
string or null
Enum: "facebook" "twitter" "google" "apple"
contacted
boolean
sequence
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

retrieveContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters
id
required
string
query Parameters
batch
string

batch

batch__isnull
string

batch__isnull

provider
string
Enum: "facebook" "twitter" "google" "apple"

provider

provider__isnull
string

provider__isnull

contact
string

contact

contact__isnull
string

contact__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

updateContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters
id
required
string
query Parameters
batch
string

batch

batch__isnull
string

batch__isnull

provider
string
Enum: "facebook" "twitter" "google" "apple"

provider

provider__isnull
string

provider__isnull

contact
string

contact

contact__isnull
string

contact__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
batch
integer or null
contact
required
integer
provider
string or null
Enum: "facebook" "twitter" "google" "apple"
contacted
boolean
sequence
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

partialUpdateContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters
id
required
string
query Parameters
batch
string

batch

batch__isnull
string

batch__isnull

provider
string
Enum: "facebook" "twitter" "google" "apple"

provider

provider__isnull
string

provider__isnull

contact
string

contact

contact__isnull
string

contact__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
batch
integer or null
contact
required
integer
provider
string or null
Enum: "facebook" "twitter" "google" "apple"
contacted
boolean
sequence
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

destroyContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters
id
required
string
query Parameters
batch
string

batch

batch__isnull
string

batch__isnull

provider
string
Enum: "facebook" "twitter" "google" "apple"

provider

provider__isnull
string

provider__isnull

contact
string

contact

contact__isnull
string

contact__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

bulkUpsertContactMatch

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
batch
integer or null
contact
required
integer
provider
string or null
Enum: "facebook" "twitter" "google" "apple"
contacted
boolean
sequence
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "batch": 0,
  • "contact": 0,
  • "provider": "facebook",
  • "contacted": true,
  • "sequence": -2147483648
}

content-types

listContentTypes

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

retrieveContentType

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "model": "string"
}

conversation-codes

listConversationCodes

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

created_at__isnull
string

created_at__isnull

created_by
string

created_by

created_by__isnull
string

created_by__isnull

script
string

script

script__isnull
string

script__isnull

targets
string

targets

targets__isnull
string

targets__isnull

expires__gte
string

expires__gte

expires__lte
string

expires__lte

expires__isnull
string

expires__isnull

status
string
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

status

status__isnull
string

status__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

createConversationCode

Request Body schema:
description
string <= 255 characters
org
string or null <= 255 characters

The organization or cause your canvassers represent. Will display in script.

script
required
integer
targets
integer or null
expires
string or null <date-time>

Date you want code to expire.

conversation_type
string or null
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time
string or null

Time you want contact to begin. Time is local to contact's time zone.

end_time
string or null

Time you want contact to end. Time is local to contact's time zone.

status
string or null
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

Deactivated codes will not be accesible by callers or canvassers.

attempt_goal
integer [ -2147483648 .. 2147483647 ]

Default goal shown to callers or canvassers.

reg_goal
integer [ -2147483648 .. 2147483647 ]

Overall voter registration goal for code.

vbm_goal
integer [ -2147483648 .. 2147483647 ]

Overall vote by mail registration goal for code.

conversations_set
required
Array of integers
min_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.

max_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.

action_url
string or null <= 255 characters
action_text
string or null <= 255 characters
universal_source_code
string or null <= 100 characters
starting_location
integer or null
skip_people_search
boolean

Skip people search when adding people

Responses

Request samples

Content type
{
  • "description": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "description": "string",
  • "display": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

retrieveConversationCode

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

created_at__isnull
string

created_at__isnull

created_by
string

created_by

created_by__isnull
string

created_by__isnull

script
string

script

script__isnull
string

script__isnull

targets
string

targets

targets__isnull
string

targets__isnull

expires__gte
string

expires__gte

expires__lte
string

expires__lte

expires__isnull
string

expires__isnull

status
string
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

status

status__isnull
string

status__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "description": "string",
  • "display": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

updateConversationCode

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

created_at__isnull
string

created_at__isnull

created_by
string

created_by

created_by__isnull
string

created_by__isnull

script
string

script

script__isnull
string

script__isnull

targets
string

targets

targets__isnull
string

targets__isnull

expires__gte
string

expires__gte

expires__lte
string

expires__lte

expires__isnull
string

expires__isnull

status
string
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

status

status__isnull
string

status__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
description
string <= 255 characters
org
string or null <= 255 characters

The organization or cause your canvassers represent. Will display in script.

script
required
integer
targets
integer or null
expires
string or null <date-time>

Date you want code to expire.

conversation_type
string or null
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time
string or null

Time you want contact to begin. Time is local to contact's time zone.

end_time
string or null

Time you want contact to end. Time is local to contact's time zone.

status
string or null
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

Deactivated codes will not be accesible by callers or canvassers.

attempt_goal
integer [ -2147483648 .. 2147483647 ]

Default goal shown to callers or canvassers.

reg_goal
integer [ -2147483648 .. 2147483647 ]

Overall voter registration goal for code.

vbm_goal
integer [ -2147483648 .. 2147483647 ]

Overall vote by mail registration goal for code.

conversations_set
required
Array of integers
min_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.

max_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.

action_url
string or null <= 255 characters
action_text
string or null <= 255 characters
universal_source_code
string or null <= 100 characters
starting_location
integer or null
skip_people_search
boolean

Skip people search when adding people

Responses

Request samples

Content type
{
  • "description": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "description": "string",
  • "display": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

partialUpdateConversationCode

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

created_at__isnull
string

created_at__isnull

created_by
string

created_by

created_by__isnull
string

created_by__isnull

script
string

script

script__isnull
string

script__isnull

targets
string

targets

targets__isnull
string

targets__isnull

expires__gte
string

expires__gte

expires__lte
string

expires__lte

expires__isnull
string

expires__isnull

status
string
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

status

status__isnull
string

status__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
description
string <= 255 characters
org
string or null <= 255 characters

The organization or cause your canvassers represent. Will display in script.

script
required
integer
targets
integer or null
expires
string or null <date-time>

Date you want code to expire.

conversation_type
string or null
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time
string or null

Time you want contact to begin. Time is local to contact's time zone.

end_time
string or null

Time you want contact to end. Time is local to contact's time zone.

status
string or null
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

Deactivated codes will not be accesible by callers or canvassers.

attempt_goal
integer [ -2147483648 .. 2147483647 ]

Default goal shown to callers or canvassers.

reg_goal
integer [ -2147483648 .. 2147483647 ]

Overall voter registration goal for code.

vbm_goal
integer [ -2147483648 .. 2147483647 ]

Overall vote by mail registration goal for code.

conversations_set
required
Array of integers
min_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.

max_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.

action_url
string or null <= 255 characters
action_text
string or null <= 255 characters
universal_source_code
string or null <= 100 characters
starting_location
integer or null
skip_people_search
boolean

Skip people search when adding people

Responses

Request samples

Content type
{
  • "description": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "description": "string",
  • "display": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

destroyConversationCode

path Parameters
id
required
string
query Parameters
created_at
string

created_at

created_at__gte
string

created_at__gte

created_at__lte
string

created_at__lte

created_at__isnull
string

created_at__isnull

created_by
string

created_by

created_by__isnull
string

created_by__isnull

script
string

script

script__isnull
string

script__isnull

targets
string

targets

targets__isnull
string

targets__isnull

expires__gte
string

expires__gte

expires__lte
string

expires__lte

expires__isnull
string

expires__isnull

status
string
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

status

status__isnull
string

status__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

progressConversationCode

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "description": "string",
  • "display": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

bulkUpsertConversationCode

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
description
string <= 255 characters
org
string or null <= 255 characters

The organization or cause your canvassers represent. Will display in script.

script
required
integer
targets
integer or null
expires
string or null <date-time>

Date you want code to expire.

conversation_type
string or null
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time
string or null

Time you want contact to begin. Time is local to contact's time zone.

end_time
string or null

Time you want contact to end. Time is local to contact's time zone.

status
string or null
Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated"

Deactivated codes will not be accesible by callers or canvassers.

attempt_goal
integer [ -2147483648 .. 2147483647 ]

Default goal shown to callers or canvassers.

reg_goal
integer [ -2147483648 .. 2147483647 ]

Overall voter registration goal for code.

vbm_goal
integer [ -2147483648 .. 2147483647 ]

Overall vote by mail registration goal for code.

conversations_set
required
Array of integers
min_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.

max_turf_size
integer or null [ -2147483648 .. 2147483647 ]

Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.

action_url
string or null <= 255 characters
action_text
string or null <= 255 characters
universal_source_code
string or null <= 100 characters
starting_location
integer or null
skip_people_search
boolean

Skip people search when adding people

Responses

Request samples

Content type
{
  • "description": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "description": "string",
  • "display": "string",
  • "org": "string",
  • "script": 0,
  • "targets": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "start_time": "string",
  • "end_time": "string",
  • "status": "Processing",
  • "attempt_goal": -2147483648,
  • "reg_goal": -2147483648,
  • "vbm_goal": -2147483648,
  • "conversations_set": [
    ],
  • "min_turf_size": -2147483648,
  • "max_turf_size": -2147483648,
  • "action_url": "string",
  • "action_text": "string",
  • "universal_source_code": "string",
  • "starting_location": 0,
  • "skip_people_search": true
}

cc-leaderboard

listCCLeaderboards

query Parameters
page
integer

A page number within the paginated result set.

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

createCCLeaderboard

Request Body schema:
description
string <= 255 characters
attempts
required
integer
contacts
required
integer

Responses

Request samples

Content type
{
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

retrieveCCLeaderboard

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

updateCCLeaderboard

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
description
string <= 255 characters
attempts
required
integer
contacts
required
integer

Responses

Request samples

Content type
{
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

partialUpdateCCLeaderboard

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
description
string <= 255 characters
attempts
required
integer
contacts
required
integer

Responses

Request samples

Content type
{
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

destroyCCLeaderboard

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

bulkUpsertCCLeaderboard

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
description
string <= 255 characters
attempts
required
integer
contacts
required
integer

Responses

Request samples

Content type
{
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "description": "string",
  • "attempts": 0,
  • "contacts": 0
}

conversations

listConversations

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

canvasser
string

canvasser

canvasser__isnull
string

canvasser__isnull

contacted_id
string

contacted_id

contacted_id__isnull
string

contacted_id__isnull

conversation_time
string

conversation_time

conversation_time__gte
string

conversation_time__gte

conversation_time__lte
string

conversation_time__lte

conversation_time__isnull
string

conversation_time__isnull

conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"

conversation_type

conversation_type__isnull
string

conversation_type__isnull

contact_type
string
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"

contact_type

contact_type__isnull
string

contact_type__isnull

contact
string

contact

contact__isnull
string

contact__isnull

conversation_code
string

conversation_code

conversation_code__isnull
string

conversation_code__isnull

contact_script
string

contact_script

contact_script__isnull
string

contact_script__isnull

contacted_national_address_id
string

contacted_national_address_id

contacted_national_address_id__isnull
string

contacted_national_address_id__isnull

relationship_type
string
Enum: "0R" "1R" "2R" "3R"

relationship_type

relationship_type__isnull
string

relationship_type__isnull

languages_of_conversation
string

languages_of_conversation

languages_of_conversation__isnull
string

languages_of_conversation__isnull

attempt
string

Attempt

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

createConversation

Request Body schema:
canvasser
string
contacted_id
integer or null
conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type
string or null
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact
boolean or null
conversation_code
integer
contact_script
integer
contacted_national_address_id
integer or null
contacted_phone
string or null <= 128 characters
relationship_type
string or null
Enum: "0R" "1R" "2R" "3R"
languages_of_conversation
integer or null
questions_set
Array of strings

Responses

Request samples

Content type
{
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_time": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

retrieveConversation

path Parameters
id
required
string
query Parameters
canvasser
string

canvasser

canvasser__isnull
string

canvasser__isnull

contacted_id
string

contacted_id

contacted_id__isnull
string

contacted_id__isnull

conversation_time
string

conversation_time

conversation_time__gte
string

conversation_time__gte

conversation_time__lte
string

conversation_time__lte

conversation_time__isnull
string

conversation_time__isnull

conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"

conversation_type

conversation_type__isnull
string

conversation_type__isnull

contact_type
string
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"

contact_type

contact_type__isnull
string

contact_type__isnull

contact
string

contact

contact__isnull
string

contact__isnull

conversation_code
string

conversation_code

conversation_code__isnull
string

conversation_code__isnull

contact_script
string

contact_script

contact_script__isnull
string

contact_script__isnull

contacted_national_address_id
string

contacted_national_address_id

contacted_national_address_id__isnull
string

contacted_national_address_id__isnull

relationship_type
string
Enum: "0R" "1R" "2R" "3R"

relationship_type

relationship_type__isnull
string

relationship_type__isnull

languages_of_conversation
string

languages_of_conversation

languages_of_conversation__isnull
string

languages_of_conversation__isnull

attempt
string

Attempt

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_time": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

updateConversation

path Parameters
id
required
string
query Parameters
canvasser
string

canvasser

canvasser__isnull
string

canvasser__isnull

contacted_id
string

contacted_id

contacted_id__isnull
string

contacted_id__isnull

conversation_time
string

conversation_time

conversation_time__gte
string

conversation_time__gte

conversation_time__lte
string

conversation_time__lte

conversation_time__isnull
string

conversation_time__isnull

conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"

conversation_type

conversation_type__isnull
string

conversation_type__isnull

contact_type
string
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"

contact_type

contact_type__isnull
string

contact_type__isnull

contact
string

contact

contact__isnull
string

contact__isnull

conversation_code
string

conversation_code

conversation_code__isnull
string

conversation_code__isnull

contact_script
string

contact_script

contact_script__isnull
string

contact_script__isnull

contacted_national_address_id
string

contacted_national_address_id

contacted_national_address_id__isnull
string

contacted_national_address_id__isnull

relationship_type
string
Enum: "0R" "1R" "2R" "3R"

relationship_type

relationship_type__isnull
string

relationship_type__isnull

languages_of_conversation
string

languages_of_conversation

languages_of_conversation__isnull
string

languages_of_conversation__isnull

attempt
string

Attempt

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
canvasser
string
contacted_id
integer or null
conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type
string or null
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact
boolean or null
conversation_code
integer
contact_script
integer
contacted_national_address_id
integer or null
contacted_phone
string or null <= 128 characters
relationship_type
string or null
Enum: "0R" "1R" "2R" "3R"
languages_of_conversation
integer or null
questions_set
Array of strings

Responses

Request samples

Content type
{
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_time": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

partialUpdateConversation

path Parameters
id
required
string
query Parameters
canvasser
string

canvasser

canvasser__isnull
string

canvasser__isnull

contacted_id
string

contacted_id

contacted_id__isnull
string

contacted_id__isnull

conversation_time
string

conversation_time

conversation_time__gte
string

conversation_time__gte

conversation_time__lte
string

conversation_time__lte

conversation_time__isnull
string

conversation_time__isnull

conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"

conversation_type

conversation_type__isnull
string

conversation_type__isnull

contact_type
string
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"

contact_type

contact_type__isnull
string

contact_type__isnull

contact
string

contact

contact__isnull
string

contact__isnull

conversation_code
string

conversation_code

conversation_code__isnull
string

conversation_code__isnull

contact_script
string

contact_script

contact_script__isnull
string

contact_script__isnull

contacted_national_address_id
string

contacted_national_address_id

contacted_national_address_id__isnull
string

contacted_national_address_id__isnull

relationship_type
string
Enum: "0R" "1R" "2R" "3R"

relationship_type

relationship_type__isnull
string

relationship_type__isnull

languages_of_conversation
string

languages_of_conversation

languages_of_conversation__isnull
string

languages_of_conversation__isnull

attempt
string

Attempt

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
canvasser
string
contacted_id
integer or null
conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type
string or null
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact
boolean or null
conversation_code
integer
contact_script
integer
contacted_national_address_id
integer or null
contacted_phone
string or null <= 128 characters
relationship_type
string or null
Enum: "0R" "1R" "2R" "3R"
languages_of_conversation
integer or null
questions_set
Array of strings

Responses

Request samples

Content type
{
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_time": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

destroyConversation

path Parameters
id
required
string
query Parameters
canvasser
string

canvasser

canvasser__isnull
string

canvasser__isnull

contacted_id
string

contacted_id

contacted_id__isnull
string

contacted_id__isnull

conversation_time
string

conversation_time

conversation_time__gte
string

conversation_time__gte

conversation_time__lte
string

conversation_time__lte

conversation_time__isnull
string

conversation_time__isnull

conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"

conversation_type

conversation_type__isnull
string

conversation_type__isnull

contact_type
string
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"

contact_type

contact_type__isnull
string

contact_type__isnull

contact
string

contact

contact__isnull
string

contact__isnull

conversation_code
string

conversation_code

conversation_code__isnull
string

conversation_code__isnull

contact_script
string

contact_script

contact_script__isnull
string

contact_script__isnull

contacted_national_address_id
string

contacted_national_address_id

contacted_national_address_id__isnull
string

contacted_national_address_id__isnull

relationship_type
string
Enum: "0R" "1R" "2R" "3R"

relationship_type

relationship_type__isnull
string

relationship_type__isnull

languages_of_conversation
string

languages_of_conversation

languages_of_conversation__isnull
string

languages_of_conversation__isnull

attempt
string

Attempt

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

bulkUpsertConversation

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
canvasser
string
contacted_id
integer or null
conversation_type
string
Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type
string or null
Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact
boolean or null
conversation_code
integer
contact_script
integer
contacted_national_address_id
integer or null
contacted_phone
string or null <= 128 characters
relationship_type
string or null
Enum: "0R" "1R" "2R" "3R"
languages_of_conversation
integer or null
questions_set
Array of strings

Responses

Request samples

Content type
{
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "canvasser": "string",
  • "contacted_id": 0,
  • "conversation_time": "2019-08-24T14:15:22Z",
  • "conversation_type": "VK",
  • "contact_type": "NH",
  • "contact": true,
  • "conversation_code": 0,
  • "contact_script": 0,
  • "contacted_national_address_id": 0,
  • "contacted_phone": "string",
  • "relationship_type": "0R",
  • "languages_of_conversation": 0,
  • "questions_set": [
    ]
}

districts

listDistricts

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

createDistrict

Request Body schema:
originating_id
string or null <= 100 characters
reg_state
required
string <= 2 characters
media_market
string or null <= 100 characters
state_county_fips
string or null <= 100 characters
county_fips
string or null <= 100 characters
county_name
string or null <= 100 characters
sos_county_code
string or null <= 100 characters
township
string or null <= 100 characters
precinct_code
string or null <= 100 characters
precinct_name
string or null <= 100 characters
precinct_split
string or null <= 100 characters
unique_precinct_code
string or null <= 100 characters
unique_precinct_name
string or null <= 100 characters
ward
string or null <= 100 characters
congressional
string or null <= 100 characters
state_senate
string or null <= 100 characters
state_house
string or null <= 100 characters
municipal_district
string or null <= 100 characters
city_council_district
string or null <= 100 characters
county_commission
string or null <= 100 characters
county_legislative
string or null <= 100 characters
county_supervisor_district
string or null <= 100 characters
school_board
string or null <= 100 characters
school_district
string or null <= 100 characters
judicial_district
string or null <= 100 characters
elementary_school
string or null
middle_school
string or null
high_school
string or null
person
integer
address
integer
misc_districts
Array of integers

Responses

Request samples

Content type
{
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

autocompleteOptionsDistrict

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

retrieveDistrict

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

updateDistrict

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
originating_id
string or null <= 100 characters
reg_state
required
string <= 2 characters
media_market
string or null <= 100 characters
state_county_fips
string or null <= 100 characters
county_fips
string or null <= 100 characters
county_name
string or null <= 100 characters
sos_county_code
string or null <= 100 characters
township
string or null <= 100 characters
precinct_code
string or null <= 100 characters
precinct_name
string or null <= 100 characters
precinct_split
string or null <= 100 characters
unique_precinct_code
string or null <= 100 characters
unique_precinct_name
string or null <= 100 characters
ward
string or null <= 100 characters
congressional
string or null <= 100 characters
state_senate
string or null <= 100 characters
state_house
string or null <= 100 characters
municipal_district
string or null <= 100 characters
city_council_district
string or null <= 100 characters
county_commission
string or null <= 100 characters
county_legislative
string or null <= 100 characters
county_supervisor_district
string or null <= 100 characters
school_board
string or null <= 100 characters
school_district
string or null <= 100 characters
judicial_district
string or null <= 100 characters
elementary_school
string or null
middle_school
string or null
high_school
string or null
person
integer
address
integer
misc_districts
Array of integers

Responses

Request samples

Content type
{
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

partialUpdateDistrict

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
originating_id
string or null <= 100 characters
reg_state
required
string <= 2 characters
media_market
string or null <= 100 characters
state_county_fips
string or null <= 100 characters
county_fips
string or null <= 100 characters
county_name
string or null <= 100 characters
sos_county_code
string or null <= 100 characters
township
string or null <= 100 characters
precinct_code
string or null <= 100 characters
precinct_name
string or null <= 100 characters
precinct_split
string or null <= 100 characters
unique_precinct_code
string or null <= 100 characters
unique_precinct_name
string or null <= 100 characters
ward
string or null <= 100 characters
congressional
string or null <= 100 characters
state_senate
string or null <= 100 characters
state_house
string or null <= 100 characters
municipal_district
string or null <= 100 characters
city_council_district
string or null <= 100 characters
county_commission
string or null <= 100 characters
county_legislative
string or null <= 100 characters
county_supervisor_district
string or null <= 100 characters
school_board
string or null <= 100 characters
school_district
string or null <= 100 characters
judicial_district
string or null <= 100 characters
elementary_school
string or null
middle_school
string or null
high_school
string or null
person
integer
address
integer
misc_districts
Array of integers

Responses

Request samples

Content type
{
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

destroyDistrict

path Parameters
id
required
string
query Parameters
search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

bulkUpsertDistrict

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
originating_id
string or null <= 100 characters
reg_state
required
string <= 2 characters
media_market
string or null <= 100 characters
state_county_fips
string or null <= 100 characters
county_fips
string or null <= 100 characters
county_name
string or null <= 100 characters
sos_county_code
string or null <= 100 characters
township
string or null <= 100 characters
precinct_code
string or null <= 100 characters
precinct_name
string or null <= 100 characters
precinct_split
string or null <= 100 characters
unique_precinct_code
string or null <= 100 characters
unique_precinct_name
string or null <= 100 characters
ward
string or null <= 100 characters
congressional
string or null <= 100 characters
state_senate
string or null <= 100 characters
state_house
string or null <= 100 characters
municipal_district
string or null <= 100 characters
city_council_district
string or null <= 100 characters
county_commission
string or null <= 100 characters
county_legislative
string or null <= 100 characters
county_supervisor_district
string or null <= 100 characters
school_board
string or null <= 100 characters
school_district
string or null <= 100 characters
judicial_district
string or null <= 100 characters
elementary_school
string or null
middle_school
string or null
high_school
string or null
person
integer
address
integer
misc_districts
Array of integers

Responses

Request samples

Content type
{
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "originating_id": "string",
  • "reg_state": "st",
  • "media_market": "string",
  • "state_county_fips": "string",
  • "county_fips": "string",
  • "county_name": "string",
  • "sos_county_code": "string",
  • "township": "string",
  • "precinct_code": "string",
  • "precinct_name": "string",
  • "precinct_split": "string",
  • "unique_precinct_code": "string",
  • "unique_precinct_name": "string",
  • "ward": "string",
  • "congressional": "string",
  • "state_senate": "string",
  • "state_house": "string",
  • "municipal_district": "string",
  • "city_council_district": "string",
  • "county_commission": "string",
  • "county_legislative": "string",
  • "county_supervisor_district": "string",
  • "school_board": "string",
  • "school_district": "string",
  • "judicial_district": "string",
  • "elementary_school": "string",
  • "middle_school": "string",
  • "high_school": "string",
  • "person": 0,
  • "address": 0,
  • "misc_districts": [
    ]
}

external-data

listExternalDatas

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

resource_type
string

resource_type

resource_type__isnull
string

resource_type__isnull

mapping_type
string
Enum: "mobilize-attendance" "mobilize-event"

mapping_type

mapping_type__isnull
string

mapping_type__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

createExternalData

Request Body schema:
mapping
object or null
resource_type
required
integer
resource_id
required
integer [ 0 .. 2147483647 ]
mapping_type
required
string
Enum: "mobilize-attendance" "mobilize-event"

Responses

Request samples

Content type
{
  • "mapping": { },
  • "resource_type": 0,
  • "resource_id": 2147483647,
  • "mapping_type": "mobilize-attendance"
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "resource": "string",
  • "mapping": { },
  • "resource_type": 0,
  • "resource_id": 2147483647,
  • "mapping_type": "mobilize-attendance"
}

retrieveExternalData

path Parameters
id
required
string
query Parameters
resource_type
string

resource_type

resource_type__isnull
string

resource_type__isnull

mapping_type
string
Enum: "mobilize-attendance" "mobilize-event"

mapping_type

mapping_type__isnull
string

mapping_type__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "resource": "string",
  • "mapping": { },
  • "resource_type": 0,
  • "resource_id": 2147483647,
  • "mapping_type": "mobilize-attendance"
}

updateExternalData

path Parameters
id
required
string
query Parameters
resource_type
string

resource_type

resource_type__isnull
string

resource_type__isnull

mapping_type
string
Enum: "mobilize-attendance" "mobilize-event"

mapping_type

mapping_type__isnull
string

mapping_type__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
mapping
object or null
resource_type
required
integer
resource_id
required
integer [ 0 .. 2147483647 ]
mapping_type
required
string
Enum: "mobilize-attendance" "mobilize-event"

Responses

Request samples

Content type
{
  • "mapping": { },
  • "resource_type": 0,
  • "resource_id": 2147483647,
  • "mapping_type": "mobilize-attendance"
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "resource": "string",
  • "mapping": { },
  • "resource_type": 0,
  • "resource_id": 2147483647,
  • "mapping_type": "mobilize-attendance"
}

partialUpdateExternalData

path Parameters
id
required
string
query Parameters
resource_type
string

resource_type

resource_type__isnull
string

resource_type__isnull

mapping_type
string
Enum: "mobilize-attendance" "mobilize-event"

mapping_type

mapping_type__isnull
string

mapping_type__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Request Body schema:
mapping
object or null
resource_type
required
integer
resource_id
required
integer [ 0 .. 2147483647 ]
mapping_type
required
string
Enum: "mobilize-attendance" "mobilize-event"

Responses

Request samples

Content type
{
  • "mapping": { },
  • "resource_type": 0,
  • "resource_id": 2147483647,
  • "mapping_type": "mobilize-attendance"
}

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": 0,
  • "resource": "string",
  • "mapping": { },
  • "resource_type": 0,
  • "resource_id": 2147483647,
  • "mapping_type": "mobilize-attendance"
}

destroyExternalData

path Parameters
id
required
string
query Parameters
resource_type
string

resource_type

resource_type__isnull
string

resource_type__isnull

mapping_type
string
Enum: "mobilize-attendance" "mobilize-event"

mapping_type

mapping_type__isnull
string

mapping_type__isnull

search
string

A search term.

ordering
string

Which field to use when ordering the results.

Responses