The endpoint for Quorum Outbox email campaigns.
Saving a draft: POST creates a draft and PATCH updates it. Saving never sends the email.
Sending or scheduling a draft: PATCH /api/bulkemail/{id}/?send_message=true with current_status 3 (injecting) and a scheduled_send_time:
is_scheduled false and the current time.is_scheduled true and a future time. The email is held and sent at that time.current_status 3, the request only saves the draft. scheduled_send_time is required on a send. It is an ISO 8601 date and time; a value without a UTC offset is read in America/New_York. A scheduled time can't be more than 10 minutes in the past.current_status is 14 (scheduled): PATCH /api/bulkemail/{id}/?cancel_bulk_email=true with an empty body returns it to an editable draft. Edit it, then send or schedule it again; to send it now, set is_scheduled to false.is_draft defaults to true and is set by the server: it becomes false when the email is sent or scheduled. You don't need to send it, and a client can't set it to false.current_status: a client may set only 1 (draft), while the email is still a draft, or 3 (injecting) on a send request.| archived | boolean |
| clicks | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| created | string <date-time> NOTE: Parameter accepts additional qualifiers appended to the end: |
| email_count | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| from_name | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| id | integer <int64> Quorum ID (Primary Key) |
| is_draft | boolean |
| is_scheduled | boolean |
| old_outbox_email | boolean |
| opens | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| person_count | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| projects | Array of integers <int64> The projects that are associated with this bulkemail. NOTE: Parameter accepts additional qualifiers appended to the end: |
| reply_count | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| reply_to_address | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| sent_datetime | string <date-time> NOTE: Parameter accepts additional qualifiers appended to the end: |
| source | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name BulkEmailSource, for an explanation of values. |
| subject | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| supporter_count | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| unsubscribes | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| updated | string <date-time> NOTE: Parameter accepts additional qualifiers appended to the end: |
| user_id | integer <int64> The quorumuser with which this bulkemail is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| variant_of_id | integer <int64> The bulkemail with which this bulkemail is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| winner_of_id | integer <int64> The bulkemail with which this bulkemail is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| dehydrate | Array of strings Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values. |
| dehydrate_extra | Array of strings Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values. |
| 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). |
BulkEmail retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "abtest": "/api/abtest/1/",
- "ac_unsubscribes": 0,
- "action_center_id": "/api/actioncentersettings/1/",
- "actions": 0,
- "admin_bounces": 0,
- "aggregate_ac_unsubscribes": 0,
- "aggregate_clicks": 0,
- "aggregate_opens": 0,
- "aggregate_opens_with_prefetched": 0,
- "aggregate_unsubscribes": 0,
- "ai_suggestion": { },
- "archived": false,
- "attachments": "/api/attachment/1/",
- "attempted_resend_count": 0,
- "bcc_rcpts": [
- "string"
], - "block_bounces": 0,
- "bounce_reason_breakdown": { },
- "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "celery_task_id": "78ba38fc-bdbb-4964-8167-08e495e04b1b",
- "click_rate": 0,
- "clicks": 0,
- "compose_tool": "summernote",
- "content_version": 1,
- "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": "",
- "failed_recipients": { },
- "from_address": "string",
- "from_name": "string",
- "from_user": "/api/user/1/",
- "hard_bounces": 0,
- "html_content": "",
- "id": 0,
- "initial_opens": 0,
- "is_abtest": true,
- "is_custom_unsubscribe": false,
- "is_draft": true,
- "is_feed_events_archived": false,
- "is_message_events_archived": false,
- "is_moved": false,
- "is_scheduled": false,
- "is_updating": false,
- "json_content": { },
- "last_updated": "2019-08-24T14:15:22Z",
- "limited_to_teams": [
- "/api/team/1/"
], - "link_dict": { },
- "must_send_as_creator": true,
- "open_rate": 0,
- "open_rate_with_prefetched": 0,
- "opens": 0,
- "opens_with_prefetched": 0,
- "percent_opened": 0,
- "person_count": 0,
- "prefetched_opens": 0,
- "press_count": 0,
- "projects": [
- "/api/project/1/"
], - "recipient_domain_breakdown": { },
- "reply_count": 0,
- "reply_to_address": "string",
- "reply_to_assignments": false,
- "reply_to_name": "string",
- "reply_to_user": "/api/user/1/",
- "resource_uri": "string",
- "root_bulk_email": "string",
- "saved_by_user": false,
- "scheduled_send_time": "string",
- "selection_json": { },
- "selection_json_old": { },
- "send_from_assignments": false,
- "sent_datetime": "2019-08-24T14:15:22Z",
- "should_cc_all": false,
- "should_stagger_send": false,
- "soft_bounces": 0,
- "source": 1,
- "spam_complaints": 0,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "total_bounced_recipients": 0,
- "undetermined_bounces": 0,
- "unsubscribe_enabled": false,
- "unsubscribes": 0,
- "updated": "2019-08-24T14:15:22Z",
- "use_personal_email": false,
- "user": "/api/user/1/",
- "variant_of": "/api/bulkemail/1/",
- "variants": "/api/bulkemail/1/",
- "was_imported": false,
- "winner": "/api/bulkemail/1/",
- "winner_of": "/api/bulkemail/1/"
}| archived | boolean |
| bcc_rcpts | Array of strings |
| cc_rcpts | Array of strings |
| compose_tool | string |
| content_version | integer <int64> |
| current_status | integer <int64> See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name EmailStatus, for an explanation of values. |
| custom_event_id | string <{"id": QUORUM_ID}> The customevent with which this bulkemail is associated. |
| excludes_json | string String-encoded JSON Object. This field requires special handling. |
| external_id | string |
| from_address | string |
| from_name | string |
| from_user_id | string <{"id": QUORUM_ID}> The quorumuser with which this bulkemail is associated. |
| html_content | string |
| is_custom_unsubscribe | boolean |
| is_draft | boolean |
| is_scheduled | boolean |
| json_content | string String-encoded JSON Object. This field requires special handling. |
| 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 projects that are associated with this bulkemail. |
| reply_to_address | string |
| reply_to_assignments | boolean |
| reply_to_name | string |
| reply_to_user_id | string <{"id": QUORUM_ID}> The quorumuser with which this bulkemail is associated. |
| scheduled_send_time | string |
| selection_json | string String-encoded JSON Object. This field requires special handling. |
| send_from_assignments | boolean |
| should_cc_all | boolean |
| subject | string |
| unsubscribe_enabled | boolean |
| use_personal_email | boolean |
BulkEmail retrieved successfully
improperly configured request
authorization failure
internal server error
{- "archived": true,
- "bcc_rcpts": [
- "string"
], - "cc_rcpts": [
- "string"
], - "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_custom_unsubscribe": true,
- "is_draft": true,
- "is_scheduled": true,
- "json_content": "string",
- "limited_to_teams": [
- "string"
], - "projects": [
- "string"
], - "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
}{- "_extra": { },
- "abtest": "/api/abtest/1/",
- "ac_unsubscribes": 0,
- "action_center_id": "/api/actioncentersettings/1/",
- "actions": 0,
- "admin_bounces": 0,
- "aggregate_ac_unsubscribes": 0,
- "aggregate_clicks": 0,
- "aggregate_opens": 0,
- "aggregate_opens_with_prefetched": 0,
- "aggregate_unsubscribes": 0,
- "ai_suggestion": { },
- "archived": false,
- "attachments": "/api/attachment/1/",
- "attempted_resend_count": 0,
- "bcc_rcpts": [
- "string"
], - "block_bounces": 0,
- "bounce_reason_breakdown": { },
- "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "celery_task_id": "78ba38fc-bdbb-4964-8167-08e495e04b1b",
- "click_rate": 0,
- "clicks": 0,
- "compose_tool": "summernote",
- "content_version": 1,
- "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": "",
- "failed_recipients": { },
- "from_address": "string",
- "from_name": "string",
- "from_user": "/api/user/1/",
- "hard_bounces": 0,
- "html_content": "",
- "id": 0,
- "initial_opens": 0,
- "is_abtest": true,
- "is_custom_unsubscribe": false,
- "is_draft": true,
- "is_feed_events_archived": false,
- "is_message_events_archived": false,
- "is_moved": false,
- "is_scheduled": false,
- "is_updating": false,
- "json_content": { },
- "last_updated": "2019-08-24T14:15:22Z",
- "limited_to_teams": [
- "/api/team/1/"
], - "link_dict": { },
- "must_send_as_creator": true,
- "open_rate": 0,
- "open_rate_with_prefetched": 0,
- "opens": 0,
- "opens_with_prefetched": 0,
- "percent_opened": 0,
- "person_count": 0,
- "prefetched_opens": 0,
- "press_count": 0,
- "projects": [
- "/api/project/1/"
], - "recipient_domain_breakdown": { },
- "reply_count": 0,
- "reply_to_address": "string",
- "reply_to_assignments": false,
- "reply_to_name": "string",
- "reply_to_user": "/api/user/1/",
- "resource_uri": "string",
- "root_bulk_email": "string",
- "saved_by_user": false,
- "scheduled_send_time": "string",
- "selection_json": { },
- "selection_json_old": { },
- "send_from_assignments": false,
- "sent_datetime": "2019-08-24T14:15:22Z",
- "should_cc_all": false,
- "should_stagger_send": false,
- "soft_bounces": 0,
- "source": 1,
- "spam_complaints": 0,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "total_bounced_recipients": 0,
- "undetermined_bounces": 0,
- "unsubscribe_enabled": false,
- "unsubscribes": 0,
- "updated": "2019-08-24T14:15:22Z",
- "use_personal_email": false,
- "user": "/api/user/1/",
- "variant_of": "/api/bulkemail/1/",
- "variants": "/api/bulkemail/1/",
- "was_imported": false,
- "winner": "/api/bulkemail/1/",
- "winner_of": "/api/bulkemail/1/"
}BulkEmail retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "abtest": "/api/abtest/1/",
- "ac_unsubscribes": 0,
- "action_center_id": "/api/actioncentersettings/1/",
- "actions": 0,
- "admin_bounces": 0,
- "aggregate_ac_unsubscribes": 0,
- "aggregate_clicks": 0,
- "aggregate_opens": 0,
- "aggregate_opens_with_prefetched": 0,
- "aggregate_unsubscribes": 0,
- "ai_suggestion": { },
- "archived": false,
- "attachments": "/api/attachment/1/",
- "attempted_resend_count": 0,
- "bcc_rcpts": [
- "string"
], - "block_bounces": 0,
- "bounce_reason_breakdown": { },
- "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "celery_task_id": "78ba38fc-bdbb-4964-8167-08e495e04b1b",
- "click_rate": 0,
- "clicks": 0,
- "compose_tool": "summernote",
- "content_version": 1,
- "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": "",
- "failed_recipients": { },
- "from_address": "string",
- "from_name": "string",
- "from_user": "/api/user/1/",
- "hard_bounces": 0,
- "html_content": "",
- "id": 0,
- "initial_opens": 0,
- "is_abtest": true,
- "is_custom_unsubscribe": false,
- "is_draft": true,
- "is_feed_events_archived": false,
- "is_message_events_archived": false,
- "is_moved": false,
- "is_scheduled": false,
- "is_updating": false,
- "json_content": { },
- "last_updated": "2019-08-24T14:15:22Z",
- "limited_to_teams": [
- "/api/team/1/"
], - "link_dict": { },
- "must_send_as_creator": true,
- "open_rate": 0,
- "open_rate_with_prefetched": 0,
- "opens": 0,
- "opens_with_prefetched": 0,
- "percent_opened": 0,
- "person_count": 0,
- "prefetched_opens": 0,
- "press_count": 0,
- "projects": [
- "/api/project/1/"
], - "recipient_domain_breakdown": { },
- "reply_count": 0,
- "reply_to_address": "string",
- "reply_to_assignments": false,
- "reply_to_name": "string",
- "reply_to_user": "/api/user/1/",
- "resource_uri": "string",
- "root_bulk_email": "string",
- "saved_by_user": false,
- "scheduled_send_time": "string",
- "selection_json": { },
- "selection_json_old": { },
- "send_from_assignments": false,
- "sent_datetime": "2019-08-24T14:15:22Z",
- "should_cc_all": false,
- "should_stagger_send": false,
- "soft_bounces": 0,
- "source": 1,
- "spam_complaints": 0,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "total_bounced_recipients": 0,
- "undetermined_bounces": 0,
- "unsubscribe_enabled": false,
- "unsubscribes": 0,
- "updated": "2019-08-24T14:15:22Z",
- "use_personal_email": false,
- "user": "/api/user/1/",
- "variant_of": "/api/bulkemail/1/",
- "variants": "/api/bulkemail/1/",
- "was_imported": false,
- "winner": "/api/bulkemail/1/",
- "winner_of": "/api/bulkemail/1/"
}| archived | boolean |
| bcc_rcpts | Array of strings |
| cc_rcpts | Array of strings |
| compose_tool | string |
| content_version | integer <int64> |
| current_status | integer <int64> See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name EmailStatus, for an explanation of values. |
| custom_event_id | string <{"id": QUORUM_ID}> The customevent with which this bulkemail is associated. |
| excludes_json | string String-encoded JSON Object. This field requires special handling. |
| external_id | string |
| from_address | string |
| from_name | string |
| from_user_id | string <{"id": QUORUM_ID}> The quorumuser with which this bulkemail is associated. |
| html_content | string |
| is_custom_unsubscribe | boolean |
| is_draft | boolean |
| is_scheduled | boolean |
| json_content | string String-encoded JSON Object. This field requires special handling. |
| 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 projects that are associated with this bulkemail. |
| reply_to_address | string |
| reply_to_assignments | boolean |
| reply_to_name | string |
| reply_to_user_id | string <{"id": QUORUM_ID}> The quorumuser with which this bulkemail is associated. |
| scheduled_send_time | string |
| selection_json | string String-encoded JSON Object. This field requires special handling. |
| send_from_assignments | boolean |
| should_cc_all | boolean |
| subject | string |
| unsubscribe_enabled | boolean |
| use_personal_email | boolean |
BulkEmail retrieved successfully
improperly configured request
authorization failure
internal server error
{- "archived": true,
- "bcc_rcpts": [
- "string"
], - "cc_rcpts": [
- "string"
], - "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_custom_unsubscribe": true,
- "is_draft": true,
- "is_scheduled": true,
- "json_content": "string",
- "limited_to_teams": [
- "string"
], - "projects": [
- "string"
], - "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
}{- "_extra": { },
- "abtest": "/api/abtest/1/",
- "ac_unsubscribes": 0,
- "action_center_id": "/api/actioncentersettings/1/",
- "actions": 0,
- "admin_bounces": 0,
- "aggregate_ac_unsubscribes": 0,
- "aggregate_clicks": 0,
- "aggregate_opens": 0,
- "aggregate_opens_with_prefetched": 0,
- "aggregate_unsubscribes": 0,
- "ai_suggestion": { },
- "archived": false,
- "attachments": "/api/attachment/1/",
- "attempted_resend_count": 0,
- "bcc_rcpts": [
- "string"
], - "block_bounces": 0,
- "bounce_reason_breakdown": { },
- "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "celery_task_id": "78ba38fc-bdbb-4964-8167-08e495e04b1b",
- "click_rate": 0,
- "clicks": 0,
- "compose_tool": "summernote",
- "content_version": 1,
- "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": "",
- "failed_recipients": { },
- "from_address": "string",
- "from_name": "string",
- "from_user": "/api/user/1/",
- "hard_bounces": 0,
- "html_content": "",
- "id": 0,
- "initial_opens": 0,
- "is_abtest": true,
- "is_custom_unsubscribe": false,
- "is_draft": true,
- "is_feed_events_archived": false,
- "is_message_events_archived": false,
- "is_moved": false,
- "is_scheduled": false,
- "is_updating": false,
- "json_content": { },
- "last_updated": "2019-08-24T14:15:22Z",
- "limited_to_teams": [
- "/api/team/1/"
], - "link_dict": { },
- "must_send_as_creator": true,
- "open_rate": 0,
- "open_rate_with_prefetched": 0,
- "opens": 0,
- "opens_with_prefetched": 0,
- "percent_opened": 0,
- "person_count": 0,
- "prefetched_opens": 0,
- "press_count": 0,
- "projects": [
- "/api/project/1/"
], - "recipient_domain_breakdown": { },
- "reply_count": 0,
- "reply_to_address": "string",
- "reply_to_assignments": false,
- "reply_to_name": "string",
- "reply_to_user": "/api/user/1/",
- "resource_uri": "string",
- "root_bulk_email": "string",
- "saved_by_user": false,
- "scheduled_send_time": "string",
- "selection_json": { },
- "selection_json_old": { },
- "send_from_assignments": false,
- "sent_datetime": "2019-08-24T14:15:22Z",
- "should_cc_all": false,
- "should_stagger_send": false,
- "soft_bounces": 0,
- "source": 1,
- "spam_complaints": 0,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "total_bounced_recipients": 0,
- "undetermined_bounces": 0,
- "unsubscribe_enabled": false,
- "unsubscribes": 0,
- "updated": "2019-08-24T14:15:22Z",
- "use_personal_email": false,
- "user": "/api/user/1/",
- "variant_of": "/api/bulkemail/1/",
- "variants": "/api/bulkemail/1/",
- "was_imported": false,
- "winner": "/api/bulkemail/1/",
- "winner_of": "/api/bulkemail/1/"
}