Send email or SMS

POST /mass_emails

application/json

Body Required

type string

Values are email or sms.
message string(email)
subject string
registration_id integer

Required if sending only single message
params array[object]

Same parameters as when filtering registrations
Hide params attributes Show params attributes object
- advanced_search boolean
- schedule_id integer
- course_id integer
- place_id integer
- room_id integer
- trainer_id integer
- billing_period_id integer
- billing_status string
  
  Values are paid, unpaid, partially_paid, or overpaid.
- user string
- user_id integer
- email string
- registration_id integer
- exclude string
- exclude_user string
- order_id integer
- parent integer
- distinct boolean
- payment_id integer
- inactive_customers boolean
- marketing_messages boolean
- ef_full_name string
- status string
- created_from string
- created_to string
- schedule_groups string
- schedule_query string

Responses

200 application/json

Result of the operation
Hide response attribute Show response attribute object
- result boolean

POST /mass_emails

curl \
 --request POST 'https://api.zooza.app/v1/mass_emails' \
 --header "Content-Type: application/json" \
 --data '{"type":"email","message":"hello@example.com","subject":"string","registration_id":42,"params":[{"advanced_search":true,"schedule_id":42,"course_id":42,"place_id":42,"room_id":42,"trainer_id":42,"billing_period_id":42,"billing_status":"paid","user":"string","user_id":42,"email":"string","registration_id":42,"exclude":"string","exclude_user":"string","order_id":42,"parent":42,"distinct":true,"payment_id":42,"inactive_customers":true,"marketing_messages":true,"ef_full_name":"string","status":"string","created_from":"string","created_to":"string","schedule_groups":"string","schedule_query":"string"}]}'

Request examples

{
  "type": "email",
  "message": "hello@example.com",
  "subject": "string",
  "registration_id": 42,
  "params": [
    {
      "advanced_search": true,
      "schedule_id": 42,
      "course_id": 42,
      "place_id": 42,
      "room_id": 42,
      "trainer_id": 42,
      "billing_period_id": 42,
      "billing_status": "paid",
      "user": "string",
      "user_id": 42,
      "email": "string",
      "registration_id": 42,
      "exclude": "string",
      "exclude_user": "string",
      "order_id": 42,
      "parent": 42,
      "distinct": true,
      "payment_id": 42,
      "inactive_customers": true,
      "marketing_messages": true,
      "ef_full_name": "string",
      "status": "string",
      "created_from": "string",
      "created_to": "string",
      "schedule_groups": "string",
      "schedule_query": "string"
    }
  ]
}

Response examples (200)

{
  "result": true
}