BulkEmail retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "abtest": "/api/abtest/1/",
- "actions": 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"
], - "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "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/",
- "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/"
], - "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,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "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/",
- "actions": 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"
], - "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "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/",
- "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/"
], - "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,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "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/",
- "actions": 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"
], - "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "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/",
- "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/"
], - "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,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "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/",
- "actions": 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"
], - "bounces": 0,
- "campaigns": "1/",
- "cc_rcpts": [
- "string"
], - "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/",
- "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/"
], - "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,
- "subject": "",
- "supporter_bounces": 0,
- "supporter_count": 0,
- "text": "",
- "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/"
}