> For the complete documentation index, see [llms.txt](https://docs.mediarithmics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mediarithmics.io/api-reference/deprecated/email-blasts.md).

# Email Blasts

Operations related to Email Blasts, the individual email sending operations within email campaigns. Each blast represents a specific email send execution with its own scheduling, target audience selection, template assignment, and delivery tracking. Multiple blasts can be created within a single email campaign for A/B testing or sequential communications.

## GET /email\_campaigns/{campaign\_id}/email\_blasts

> Get email blasts in an email campaign

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Email Blasts","description":"Operations related to Email Blasts, the individual email sending operations within email campaigns. Each blast represents a specific email send execution with its own scheduling, target audience selection, template assignment, and delivery tracking. Multiple blasts can be created within a single email campaign for A/B testing or sequential communications."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/email_campaigns/{campaign_id}/email_blasts":{"get":{"description":"","tags":["Email Blasts"],"operationId":"getEmailBlasts","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailBlastResource"}},"total":{"type":"integer"},"max_results":{"type":"integer"},"first_result":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"schema":{"type":"integer","format":"int64"},"required":true,"style":"simple","explode":false,"name":"campaign_id","in":"path"}],"summary":"Get email blasts in an email campaign"}}},"components":{"schemas":{"EmailBlastResource":{"allOf":[{"$ref":"#/components/schemas/EmailBlast"},{"type":"object","properties":{"subject_line":{"type":"string","readOnly":false},"batch_size":{"type":"integer","format":"int32","default":0,"readOnly":true},"capping_period":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"id":{"type":"string","readOnly":true},"reply_to":{"type":"string","readOnly":false},"from_email":{"type":"string","readOnly":false},"from_name":{"type":"string","readOnly":false},"capping":{"type":"integer","format":"int32","default":0,"readOnly":false},"number_mail_not_send":{"type":"integer","format":"int32","default":0,"readOnly":true},"blast_name":{"type":"string","readOnly":false},"min_period_between_shoots":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"status":{"$ref":"#/components/schemas/EmailBlastStatus"},"send_date":{"type":"integer","format":"int64","default":0,"readOnly":false},"campaign_id":{"type":"string","readOnly":true}},"required":["batch_size","blast_name","campaign_id","capping","capping_period","from_email","from_name","id","min_period_between_shoots","number_mail_not_send","reply_to","send_date","status","subject_line"]}]},"EmailBlast":{"type":"object"},"EmailBlastStatus":{"type":"string","enum":["SCENARIO_ACTIVATED","PENDING","SCHEDULED","FINISHED","ERROR"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /email\_campaigns/{campaign\_id}/email\_blasts

> create an email blast

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Email Blasts","description":"Operations related to Email Blasts, the individual email sending operations within email campaigns. Each blast represents a specific email send execution with its own scheduling, target audience selection, template assignment, and delivery tracking. Multiple blasts can be created within a single email campaign for A/B testing or sequential communications."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/email_campaigns/{campaign_id}/email_blasts":{"post":{"operationId":"createEmailBlast","summary":"create an email blast","parameters":[{"schema":{"type":"integer","format":"int64"},"in":"path","name":"campaign_id","style":"simple","explode":false,"required":true}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/EmailBlastResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Email Blasts"],"requestBody":{"description":"The Email Blast to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailBlastResource"}}},"required":true},"description":""}}},"components":{"schemas":{"EmailBlastResource":{"allOf":[{"$ref":"#/components/schemas/EmailBlast"},{"type":"object","properties":{"subject_line":{"type":"string","readOnly":false},"batch_size":{"type":"integer","format":"int32","default":0,"readOnly":true},"capping_period":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"id":{"type":"string","readOnly":true},"reply_to":{"type":"string","readOnly":false},"from_email":{"type":"string","readOnly":false},"from_name":{"type":"string","readOnly":false},"capping":{"type":"integer","format":"int32","default":0,"readOnly":false},"number_mail_not_send":{"type":"integer","format":"int32","default":0,"readOnly":true},"blast_name":{"type":"string","readOnly":false},"min_period_between_shoots":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"status":{"$ref":"#/components/schemas/EmailBlastStatus"},"send_date":{"type":"integer","format":"int64","default":0,"readOnly":false},"campaign_id":{"type":"string","readOnly":true}},"required":["batch_size","blast_name","campaign_id","capping","capping_period","from_email","from_name","id","min_period_between_shoots","number_mail_not_send","reply_to","send_date","status","subject_line"]}]},"EmailBlast":{"type":"object"},"EmailBlastStatus":{"type":"string","enum":["SCENARIO_ACTIVATED","PENDING","SCHEDULED","FINISHED","ERROR"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /email\_campaigns/{campaign\_id}/email\_blasts/{id}

> Get email blasts in an email campaign by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Email Blasts","description":"Operations related to Email Blasts, the individual email sending operations within email campaigns. Each blast represents a specific email send execution with its own scheduling, target audience selection, template assignment, and delivery tracking. Multiple blasts can be created within a single email campaign for A/B testing or sequential communications."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/email_campaigns/{campaign_id}/email_blasts/{id}":{"get":{"parameters":[{"schema":{"type":"integer","format":"int64"},"style":"simple","in":"path","explode":false,"name":"campaign_id","required":true},{"required":true,"name":"id","explode":false,"schema":{"type":"integer","format":"int64"},"style":"simple","in":"path"}],"summary":"Get email blasts in an email campaign by id","operationId":"getEmailBlast","description":"","tags":["Email Blasts"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/EmailBlastResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"EmailBlastResource":{"allOf":[{"$ref":"#/components/schemas/EmailBlast"},{"type":"object","properties":{"subject_line":{"type":"string","readOnly":false},"batch_size":{"type":"integer","format":"int32","default":0,"readOnly":true},"capping_period":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"id":{"type":"string","readOnly":true},"reply_to":{"type":"string","readOnly":false},"from_email":{"type":"string","readOnly":false},"from_name":{"type":"string","readOnly":false},"capping":{"type":"integer","format":"int32","default":0,"readOnly":false},"number_mail_not_send":{"type":"integer","format":"int32","default":0,"readOnly":true},"blast_name":{"type":"string","readOnly":false},"min_period_between_shoots":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"status":{"$ref":"#/components/schemas/EmailBlastStatus"},"send_date":{"type":"integer","format":"int64","default":0,"readOnly":false},"campaign_id":{"type":"string","readOnly":true}},"required":["batch_size","blast_name","campaign_id","capping","capping_period","from_email","from_name","id","min_period_between_shoots","number_mail_not_send","reply_to","send_date","status","subject_line"]}]},"EmailBlast":{"type":"object"},"EmailBlastStatus":{"type":"string","enum":["SCENARIO_ACTIVATED","PENDING","SCHEDULED","FINISHED","ERROR"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /email\_campaigns/{campaign\_id}/email\_blasts/{id}

> update an email blast

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Email Blasts","description":"Operations related to Email Blasts, the individual email sending operations within email campaigns. Each blast represents a specific email send execution with its own scheduling, target audience selection, template assignment, and delivery tracking. Multiple blasts can be created within a single email campaign for A/B testing or sequential communications."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/email_campaigns/{campaign_id}/email_blasts/{id}":{"put":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/EmailBlastResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","parameters":[{"in":"path","name":"campaign_id","required":true,"style":"simple","schema":{"type":"integer","format":"int64"},"explode":false},{"required":true,"style":"simple","schema":{"type":"integer","format":"int64"},"name":"id","explode":false,"in":"path"}],"operationId":"updateEmailBlast","summary":"update an email blast","tags":["Email Blasts"],"requestBody":{"description":"The Email Blast to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailBlastResource"}}},"required":true}}}},"components":{"schemas":{"EmailBlastResource":{"allOf":[{"$ref":"#/components/schemas/EmailBlast"},{"type":"object","properties":{"subject_line":{"type":"string","readOnly":false},"batch_size":{"type":"integer","format":"int32","default":0,"readOnly":true},"capping_period":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"id":{"type":"string","readOnly":true},"reply_to":{"type":"string","readOnly":false},"from_email":{"type":"string","readOnly":false},"from_name":{"type":"string","readOnly":false},"capping":{"type":"integer","format":"int32","default":0,"readOnly":false},"number_mail_not_send":{"type":"integer","format":"int32","default":0,"readOnly":true},"blast_name":{"type":"string","readOnly":false},"min_period_between_shoots":{"type":"string","description":"A valid ISO 8601 Period String","readOnly":false},"status":{"$ref":"#/components/schemas/EmailBlastStatus"},"send_date":{"type":"integer","format":"int64","default":0,"readOnly":false},"campaign_id":{"type":"string","readOnly":true}},"required":["batch_size","blast_name","campaign_id","capping","capping_period","from_email","from_name","id","min_period_between_shoots","number_mail_not_send","reply_to","send_date","status","subject_line"]}]},"EmailBlast":{"type":"object"},"EmailBlastStatus":{"type":"string","enum":["SCENARIO_ACTIVATED","PENDING","SCHEDULED","FINISHED","ERROR"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /email\_campaigns/{campaign\_id}/email\_blasts/{id}

> remove an email blast

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Email Blasts","description":"Operations related to Email Blasts, the individual email sending operations within email campaigns. Each blast represents a specific email send execution with its own scheduling, target audience selection, template assignment, and delivery tracking. Multiple blasts can be created within a single email campaign for A/B testing or sequential communications."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/email_campaigns/{campaign_id}/email_blasts/{id}":{"delete":{"description":"","summary":"remove an email blast","operationId":"removeEmailBlast","tags":["Email Blasts"],"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"style":"simple","name":"campaign_id","schema":{"type":"integer","format":"int64"},"required":true,"in":"path","explode":false},{"name":"id","explode":false,"style":"simple","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}]}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mediarithmics.io/api-reference/deprecated/email-blasts.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.