mass-email

Create Job

Changed on
post/api/v1/mass-email

Request

  • Base URL
    https://api.ninjavan.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.ninjavan.co/api/v1/mass-email
  • Auth
    none declared

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

namestring required
template_idinteger required
object_typestring required
source_type'list_view' | 'report' | 'selected_ids' required
record_idsinteger[] nullable
source_refstring nullable
source_report_idinteger nullable
from_address_type'current_user' | 'org_wide'
from_org_address_idinteger nullable
scheduled_atstring date-time nullable

Response

Successful Response

idinteger required
tenant_idinteger required
namestring required
template_idinteger required
object_typestring required
source_type'list_view' | 'report' | 'selected_ids' required
source_refstring nullable
from_address_type'current_user' | 'org_wide' required
from_user_idinteger nullable
from_org_address_idinteger nullable
status'queued' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled' required
total_recipientsinteger required
sent_countinteger required
failed_countinteger required
skipped_countinteger required
scheduled_atstring date-time nullable
started_atstring date-time nullable
completed_atstring date-time nullable
error_messagestring nullable
created_byinteger nullable
created_atstring date-time required
updated_atstring date-time nullable

Changes