---
title: "Create Job"
method: POST
path: "/api/v1/mass-email"
tags: ["mass-email"]
---

# Create Job

`POST /api/v1/mass-email`

## Headers

- `authorization` string, nullable
- `X-API-Key` string, nullable

## Request body

- MassEmailJobCreate
  - `name` string, required
  - `template_id` integer, required
  - `object_type` string, required
  - `source_type` 'list_view' | 'report' | 'selected_ids', required
  - `record_ids` integer[], nullable
  - `source_ref` string, nullable
  - `from_address_type` 'current_user' | 'org_wide'
  - `from_org_address_id` integer, nullable
  - `scheduled_at` string, date-time, nullable

## Response `201`

Successful Response

- MassEmailJobResponse
  - `id` integer, required
  - `tenant_id` integer, required
  - `name` string, required
  - `template_id` integer, required
  - `object_type` string, required
  - `source_type` 'list_view' | 'report' | 'selected_ids', required
  - `source_ref` string, nullable
  - `from_address_type` 'current_user' | 'org_wide', required
  - `from_user_id` integer, nullable
  - `from_org_address_id` integer, nullable
  - `status` 'queued' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled', required
  - `total_recipients` integer, required
  - `sent_count` integer, required
  - `failed_count` integer, required
  - `skipped_count` integer, required
  - `scheduled_at` string, date-time, nullable
  - `started_at` string, date-time, nullable
  - `completed_at` string, date-time, nullable
  - `error_message` string, nullable
  - `created_by` integer, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ninjavan/apis/salesforce-sales-cloud-replacement.md) · [All operations](https://skmtc.net/ninjavan/apis/salesforce-sales-cloud-replacement/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjavan/salesforce-sales-cloud-replacement/revisions/fd3a41a6260b/schema)