Bulk Email

The endpoint for Quorum Outbox email campaigns

Retrieve multiple Outbox Campaigns based on search critera passed as GET Arguments

get/api/bulkemail/

The endpoint for Quorum Outbox email campaigns

Securityapi_key and user_name
Request
query Parameters
archived
boolean

Whether the record has been soft-deleted or not.

clicks
integer <int64>

How many emails sent by the bulk email have been clicked

NOTE: Parameter accepts additional qualifiers appended to the end:
clicks__in - The value for the record is in the provided array parameter (comma-separated values).
clicks__gt, clicks__gte, clicks__lt, clicks__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

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_count
integer <int64>

Number of emails sent in the bulk email

NOTE: Parameter accepts additional qualifiers appended to the end:
email_count__in - The value for the record is in the provided array parameter (comma-separated values).
email_count__gt, email_count__gte, email_count__lt, email_count__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

from_name
string

The name that is shown in the Email from field. Defaults to quorum user

NOTE: Parameter accepts additional qualifiers appended to the end:
from_name__in - The value for the record is in the provided array parameter (comma-separated values).
from_name__contains, from_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)
from_name__startswith, from_name__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
from_name__endswith, from_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)
from_name__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
from_name__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_draft
boolean

Marks whether the email is a draft

is_scheduled
boolean

Marks whether or not the sending of the email was delayed

old_outbox_email
boolean

This bool indicates if the email is pre outbox 2.0

opens
integer <int64>

How many emails sent by the bulk email have been opened

NOTE: Parameter accepts additional qualifiers appended to the end:
opens__in - The value for the record is in the provided array parameter (comma-separated values).
opens__gt, opens__gte, opens__lt, opens__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

person_count
integer <int64>

Number of people selected

NOTE: Parameter accepts additional qualifiers appended to the end:
person_count__in - The value for the record is in the provided array parameter (comma-separated values).
person_count__gt, person_count__gte, person_count__lt, person_count__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

projects
Array of integers <int64>

The project for which the email was sent

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

reply_count
integer <int64>

the number of replies to a bulkemail

NOTE: Parameter accepts additional qualifiers appended to the end:
reply_count__in - The value for the record is in the provided array parameter (comma-separated values).
reply_count__gt, reply_count__gte, reply_count__lt, reply_count__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

reply_to_address
string

Email address that responses are directed to

NOTE: Parameter accepts additional qualifiers appended to the end:
reply_to_address__in - The value for the record is in the provided array parameter (comma-separated values).
reply_to_address__contains, reply_to_address__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)
reply_to_address__startswith, reply_to_address__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
reply_to_address__endswith, reply_to_address__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)
reply_to_address__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

sent_datetime
string <date-time>

The time the bulk email is scheduled to be sent. If scheduled to be sent now, then set to current time

NOTE: Parameter accepts additional qualifiers appended to the end:
sent_datetime__year, sent_datetime__month, sent_datetime__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).

subject
string

The subject of the email

NOTE: Parameter accepts additional qualifiers appended to the end:
subject__in - The value for the record is in the provided array parameter (comma-separated values).
subject__contains, subject__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)
subject__startswith, subject__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
subject__endswith, subject__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)
subject__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

supporter_count
integer <int64>

Number of supporters selected

NOTE: Parameter accepts additional qualifiers appended to the end:
supporter_count__in - The value for the record is in the provided array parameter (comma-separated values).
supporter_count__gt, supporter_count__gte, supporter_count__lt, supporter_count__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

unsubscribes
integer <int64>

How many contacts unsubscribed from Outbox emails through a link on this email

NOTE: Parameter accepts additional qualifiers appended to the end:
unsubscribes__in - The value for the record is in the provided array parameter (comma-separated values).
unsubscribes__gt, unsubscribes__gte, unsubscribes__lt, unsubscribes__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

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

user_id
integer <int64>

User id of the person that created the email; not always the same as the from_user (the email sender)

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

variant_of_id
integer <int64>

AB tested BulkEmail that this BulkEmail is a variant of

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

winner_of_id
integer <int64>

AB Test Variant that this email is copied from, which we may send later as the winner

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

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

BulkEmail retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "abtest": "/api/abtest/1/",
  • "actions": 0,
  • "aggregate_clicks": 0,
  • "aggregate_opens": 0,
  • "aggregate_unsubscribes": 0,
  • "archived": true,
  • "attachments": "/api/attachment/1/",
  • "attempted_resend_count": 0,
  • "bcc_rcpts": [
    ],
  • "bounces": 0,
  • "campaigns": "1/",
  • "cc_rcpts": [
    ],
  • "click_rate": 0,
  • "clicks": 0,
  • "compose_tool": "string",
  • "content_version": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "current_status": 1,
  • "custom_event": "/api/customevent/1/",
  • "email_count": 0,
  • "excluded_email_count": 0,
  • "excluded_person_count": 0,
  • "excluded_press_count": 0,
  • "excluded_supporter_count": 0,
  • "excludes_json": { },
  • "excludes_json_old": { },
  • "external_id": "string",
  • "failed_recipients": { },
  • "from_address": "string",
  • "from_name": "string",
  • "from_user": "/api/user/1/",
  • "html_content": "string",
  • "id": 0,
  • "initial_opens": 0,
  • "is_abtest": true,
  • "is_draft": true,
  • "is_moved": true,
  • "is_scheduled": true,
  • "is_updating": true,
  • "json_content": { },
  • "last_updated": "2019-08-24T14:15:22Z",
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "merge_variables": [
    ],
  • "must_send_as_creator": true,
  • "open_rate": 0,
  • "opens": 0,
  • "percent_opened": 0,
  • "person_count": 0,
  • "press_count": 0,
  • "projects": [
    ],
  • "reply_count": 0,
  • "reply_to_address": "string",
  • "reply_to_assignments": true,
  • "reply_to_name": "string",
  • "reply_to_user": "/api/user/1/",
  • "resource_uri": "string",
  • "root_bulk_email": "string",
  • "saved_by_user": true,
  • "scheduled_send_time": "string",
  • "selection_json": { },
  • "selection_json_old": { },
  • "send_from_assignments": true,
  • "sent_datetime": "2019-08-24T14:15:22Z",
  • "should_cc_all": true,
  • "should_stagger_send": true,
  • "subject": "string",
  • "supporter_bounces": 0,
  • "supporter_count": 0,
  • "text": "string",
  • "unsubscribe_enabled": true,
  • "unsubscribes": 0,
  • "updated": "2019-08-24T14:15:22Z",
  • "use_personal_email": true,
  • "user": "/api/user/1/",
  • "variant_of": "/api/bulkemail/1/",
  • "variants": "/api/bulkemail/1/",
  • "was_imported": true,
  • "winner": "/api/bulkemail/1/",
  • "winner_of": "/api/bulkemail/1/"
}

Retrieve information on a single Outbox Campaign

get/api/bulkemail/{id}/

The endpoint for Quorum Outbox email campaigns

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

BulkEmail retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "abtest": "/api/abtest/1/",
  • "actions": 0,
  • "aggregate_clicks": 0,
  • "aggregate_opens": 0,
  • "aggregate_unsubscribes": 0,
  • "archived": true,
  • "attachments": "/api/attachment/1/",
  • "attempted_resend_count": 0,
  • "bcc_rcpts": [
    ],
  • "bounces": 0,
  • "campaigns": "1/",
  • "cc_rcpts": [
    ],
  • "click_rate": 0,
  • "clicks": 0,
  • "compose_tool": "string",
  • "content_version": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "current_status": 1,
  • "custom_event": "/api/customevent/1/",
  • "email_count": 0,
  • "excluded_email_count": 0,
  • "excluded_person_count": 0,
  • "excluded_press_count": 0,
  • "excluded_supporter_count": 0,
  • "excludes_json": { },
  • "excludes_json_old": { },
  • "external_id": "string",
  • "failed_recipients": { },
  • "from_address": "string",
  • "from_name": "string",
  • "from_user": "/api/user/1/",
  • "html_content": "string",
  • "id": 0,
  • "initial_opens": 0,
  • "is_abtest": true,
  • "is_draft": true,
  • "is_moved": true,
  • "is_scheduled": true,
  • "is_updating": true,
  • "json_content": { },
  • "last_updated": "2019-08-24T14:15:22Z",
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "merge_variables": [
    ],
  • "must_send_as_creator": true,
  • "open_rate": 0,
  • "opens": 0,
  • "percent_opened": 0,
  • "person_count": 0,
  • "press_count": 0,
  • "projects": [
    ],
  • "reply_count": 0,
  • "reply_to_address": "string",
  • "reply_to_assignments": true,
  • "reply_to_name": "string",
  • "reply_to_user": "/api/user/1/",
  • "resource_uri": "string",
  • "root_bulk_email": "string",
  • "saved_by_user": true,
  • "scheduled_send_time": "string",
  • "selection_json": { },
  • "selection_json_old": { },
  • "send_from_assignments": true,
  • "sent_datetime": "2019-08-24T14:15:22Z",
  • "should_cc_all": true,
  • "should_stagger_send": true,
  • "subject": "string",
  • "supporter_bounces": 0,
  • "supporter_count": 0,
  • "text": "string",
  • "unsubscribe_enabled": true,
  • "unsubscribes": 0,
  • "updated": "2019-08-24T14:15:22Z",
  • "use_personal_email": true,
  • "user": "/api/user/1/",
  • "variant_of": "/api/bulkemail/1/",
  • "variants": "/api/bulkemail/1/",
  • "was_imported": true,
  • "winner": "/api/bulkemail/1/",
  • "winner_of": "/api/bulkemail/1/"
}

Update a single Bulk Email by ID

patch/api/bulkemail/{id}/

The endpoint for Quorum Outbox email campaigns

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

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

Request Body schema: application/json
archived
boolean

Whether the record has been soft-deleted or not.

bcc_rcpts
Array of strings

email addresses for bcc recipients

cc_rcpts
Array of strings

email addresses for cc recipients

compose_tool
string

the type of compose tool used

content_version
integer <int64>

Version number of the bulk email's content.This value is incremented on every succesful save, to prevent concurrent saves erasing someones work.If a client attempts to save a BulkEmail without the passing in the current content_version, there is a potential save conflict.

current_status
integer <int64>

The current status of an email

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
custom_event_id
string <{"id": QUORUM_ID}>

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

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

excludes_json
string

the excludes json

external_id
string

A custom field that allows users to match this bulk email to a bulk email in an external system.

from_address
string

address email was sent from

from_name
string

The name that is shown in the Email from field. Defaults to quorum user

from_user_id
string <{"id": QUORUM_ID}>

User id of the email sender; not always the same as the user_id (the email creator)
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}

html_content
string

html content of the email

is_draft
boolean

Marks whether the email is a draft

is_scheduled
boolean

Marks whether or not the sending of the email was delayed

json_content
string

json from the email template if they choose to use one

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

The teams that are associated with this bulkemail.

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

The project for which the email was sent
Each item provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: [{"id": 410003}, {"id": 410014}]

reply_to_address
string

Email address that responses are directed to

reply_to_assignments
boolean

Determine whether the email should reply to recipients' assignments

reply_to_name
string

name of person getting reply

reply_to_user_id
string <{"id": QUORUM_ID}>

id of the person receiving reply emails
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}

scheduled_send_time
string

The YYYY-mm-ddThh:mm:ss-hh:mm string of whento send the email.

selection_json
string

the selected json

send_from_assignments
boolean

Determine whether the email should be sent from recipients' assignments

should_cc_all
boolean

Indicates whether all cc'd recipients should receive and email

subject
string

The subject of the email

unsubscribe_enabled
boolean

Marks whether or not the message will have an unsubscribe

use_personal_email
boolean

Indicates whether the personal email of a Person should be used

Responses
200

BulkEmail retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "archived": true,
  • "bcc_rcpts": [
    ],
  • "cc_rcpts": [
    ],
  • "compose_tool": "string",
  • "content_version": 0,
  • "current_status": 1,
  • "custom_event_id": "string",
  • "excludes_json": "string",
  • "external_id": "string",
  • "from_address": "string",
  • "from_name": "string",
  • "from_user_id": "string",
  • "html_content": "string",
  • "is_draft": true,
  • "is_scheduled": true,
  • "json_content": "string",
  • "limited_to_teams": [
    ],
  • "projects": [
    ],
  • "reply_to_address": "string",
  • "reply_to_assignments": true,
  • "reply_to_name": "string",
  • "reply_to_user_id": "string",
  • "scheduled_send_time": "string",
  • "selection_json": "string",
  • "send_from_assignments": true,
  • "should_cc_all": true,
  • "subject": "string",
  • "unsubscribe_enabled": true,
  • "use_personal_email": true
}
Response samples
application/json
{
  • "_extra": { },
  • "abtest": "/api/abtest/1/",
  • "actions": 0,
  • "aggregate_clicks": 0,
  • "aggregate_opens": 0,
  • "aggregate_unsubscribes": 0,
  • "archived": true,
  • "attachments": "/api/attachment/1/",
  • "attempted_resend_count": 0,
  • "bcc_rcpts": [
    ],
  • "bounces": 0,
  • "campaigns": "1/",
  • "cc_rcpts": [
    ],
  • "click_rate": 0,
  • "clicks": 0,
  • "compose_tool": "string",
  • "content_version": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "current_status": 1,
  • "custom_event": "/api/customevent/1/",
  • "email_count": 0,
  • "excluded_email_count": 0,
  • "excluded_person_count": 0,
  • "excluded_press_count": 0,
  • "excluded_supporter_count": 0,
  • "excludes_json": { },
  • "excludes_json_old": { },
  • "external_id": "string",
  • "failed_recipients": { },
  • "from_address": "string",
  • "from_name": "string",
  • "from_user": "/api/user/1/",
  • "html_content": "string",
  • "id": 0,
  • "initial_opens": 0,
  • "is_abtest": true,
  • "is_draft": true,
  • "is_moved": true,
  • "is_scheduled": true,
  • "is_updating": true,
  • "json_content": { },
  • "last_updated": "2019-08-24T14:15:22Z",
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "merge_variables": [
    ],
  • "must_send_as_creator": true,
  • "open_rate": 0,
  • "opens": 0,
  • "percent_opened": 0,
  • "person_count": 0,
  • "press_count": 0,
  • "projects": [
    ],
  • "reply_count": 0,
  • "reply_to_address": "string",
  • "reply_to_assignments": true,
  • "reply_to_name": "string",
  • "reply_to_user": "/api/user/1/",
  • "resource_uri": "string",
  • "root_bulk_email": "string",
  • "saved_by_user": true,
  • "scheduled_send_time": "string",
  • "selection_json": { },
  • "selection_json_old": { },
  • "send_from_assignments": true,
  • "sent_datetime": "2019-08-24T14:15:22Z",
  • "should_cc_all": true,
  • "should_stagger_send": true,
  • "subject": "string",
  • "supporter_bounces": 0,
  • "supporter_count": 0,
  • "text": "string",
  • "unsubscribe_enabled": true,
  • "unsubscribes": 0,
  • "updated": "2019-08-24T14:15:22Z",
  • "use_personal_email": true,
  • "user": "/api/user/1/",
  • "variant_of": "/api/bulkemail/1/",
  • "variants": "/api/bulkemail/1/",
  • "was_imported": true,
  • "winner": "/api/bulkemail/1/",
  • "winner_of": "/api/bulkemail/1/"
}

Create a single Bulk Email

post/api/bulkemail/{id}/

The endpoint for Quorum Outbox email campaigns

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

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

Request Body schema: application/json
archived
boolean

Whether the record has been soft-deleted or not.

bcc_rcpts
Array of strings

email addresses for bcc recipients

cc_rcpts
Array of strings

email addresses for cc recipients

compose_tool
string

the type of compose tool used

content_version
integer <int64>

Version number of the bulk email's content.This value is incremented on every succesful save, to prevent concurrent saves erasing someones work.If a client attempts to save a BulkEmail without the passing in the current content_version, there is a potential save conflict.

current_status
integer <int64>

The current status of an email

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
custom_event_id
string <{"id": QUORUM_ID}>

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

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

excludes_json
string

the excludes json

external_id
string

A custom field that allows users to match this bulk email to a bulk email in an external system.

from_address
string

address email was sent from

from_name
string

The name that is shown in the Email from field. Defaults to quorum user

from_user_id
string <{"id": QUORUM_ID}>

User id of the email sender; not always the same as the user_id (the email creator)
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}

html_content
string

html content of the email

is_draft
boolean

Marks whether the email is a draft

is_scheduled
boolean

Marks whether or not the sending of the email was delayed

json_content
string

json from the email template if they choose to use one

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

The teams that are associated with this bulkemail.

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

The project for which the email was sent
Each item provided must be a string-encoded JSON object with a single key, id, and the value being the Quorum ID of the object referenced. Example: [{"id": 410003}, {"id": 410014}]

reply_to_address
string

Email address that responses are directed to

reply_to_assignments
boolean

Determine whether the email should reply to recipients' assignments

reply_to_name
string

name of person getting reply

reply_to_user_id
string <{"id": QUORUM_ID}>

id of the person receiving reply emails
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}

scheduled_send_time
string

The YYYY-mm-ddThh:mm:ss-hh:mm string of whento send the email.

selection_json
string

the selected json

send_from_assignments
boolean

Determine whether the email should be sent from recipients' assignments

should_cc_all
boolean

Indicates whether all cc'd recipients should receive and email

subject
string

The subject of the email

unsubscribe_enabled
boolean

Marks whether or not the message will have an unsubscribe

use_personal_email
boolean

Indicates whether the personal email of a Person should be used

Responses
200

BulkEmail retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "archived": true,
  • "bcc_rcpts": [
    ],
  • "cc_rcpts": [
    ],
  • "compose_tool": "string",
  • "content_version": 0,
  • "current_status": 1,
  • "custom_event_id": "string",
  • "excludes_json": "string",
  • "external_id": "string",
  • "from_address": "string",
  • "from_name": "string",
  • "from_user_id": "string",
  • "html_content": "string",
  • "is_draft": true,
  • "is_scheduled": true,
  • "json_content": "string",
  • "limited_to_teams": [
    ],
  • "projects": [
    ],
  • "reply_to_address": "string",
  • "reply_to_assignments": true,
  • "reply_to_name": "string",
  • "reply_to_user_id": "string",
  • "scheduled_send_time": "string",
  • "selection_json": "string",
  • "send_from_assignments": true,
  • "should_cc_all": true,
  • "subject": "string",
  • "unsubscribe_enabled": true,
  • "use_personal_email": true
}
Response samples
application/json
{
  • "_extra": { },
  • "abtest": "/api/abtest/1/",
  • "actions": 0,
  • "aggregate_clicks": 0,
  • "aggregate_opens": 0,
  • "aggregate_unsubscribes": 0,
  • "archived": true,
  • "attachments": "/api/attachment/1/",
  • "attempted_resend_count": 0,
  • "bcc_rcpts": [
    ],
  • "bounces": 0,
  • "campaigns": "1/",
  • "cc_rcpts": [
    ],
  • "click_rate": 0,
  • "clicks": 0,
  • "compose_tool": "string",
  • "content_version": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "current_status": 1,
  • "custom_event": "/api/customevent/1/",
  • "email_count": 0,
  • "excluded_email_count": 0,
  • "excluded_person_count": 0,
  • "excluded_press_count": 0,
  • "excluded_supporter_count": 0,
  • "excludes_json": { },
  • "excludes_json_old": { },
  • "external_id": "string",
  • "failed_recipients": { },
  • "from_address": "string",
  • "from_name": "string",
  • "from_user": "/api/user/1/",
  • "html_content": "string",
  • "id": 0,
  • "initial_opens": 0,
  • "is_abtest": true,
  • "is_draft": true,
  • "is_moved": true,
  • "is_scheduled": true,
  • "is_updating": true,
  • "json_content": { },
  • "last_updated": "2019-08-24T14:15:22Z",
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "merge_variables": [
    ],
  • "must_send_as_creator": true,
  • "open_rate": 0,
  • "opens": 0,
  • "percent_opened": 0,
  • "person_count": 0,
  • "press_count": 0,
  • "projects": [
    ],
  • "reply_count": 0,
  • "reply_to_address": "string",
  • "reply_to_assignments": true,
  • "reply_to_name": "string",
  • "reply_to_user": "/api/user/1/",
  • "resource_uri": "string",
  • "root_bulk_email": "string",
  • "saved_by_user": true,
  • "scheduled_send_time": "string",
  • "selection_json": { },
  • "selection_json_old": { },
  • "send_from_assignments": true,
  • "sent_datetime": "2019-08-24T14:15:22Z",
  • "should_cc_all": true,
  • "should_stagger_send": true,
  • "subject": "string",
  • "supporter_bounces": 0,
  • "supporter_count": 0,
  • "text": "string",
  • "unsubscribe_enabled": true,
  • "unsubscribes": 0,
  • "updated": "2019-08-24T14:15:22Z",
  • "use_personal_email": true,
  • "user": "/api/user/1/",
  • "variant_of": "/api/bulkemail/1/",
  • "variants": "/api/bulkemail/1/",
  • "was_imported": true,
  • "winner": "/api/bulkemail/1/",
  • "winner_of": "/api/bulkemail/1/"
}