Bulk Operations›Bulk Email Send

Bulk Email Send

Send an email template to every record that matches your filters, in one request.

POSThttps://secure-api.setshape.com/api/bulk/lead/send-email/{crmid}

Replace {crmid} with your CRM ID, the Shape system ID that belongs to your API key. Send the standard headers on every request: Authorization: YOUR_API_AUTHORIZATION_KEY and Content-Type: application/json. See Authentication.

Filters you leave out include everything. Only record_type and template are required. Any filter you leave out isn’t applied, so a request with just those two fields emails every record of that type in your system. Double-check your filters before sending.

Body parameters

Field Type Required Description
record_type string Required The record type to email, such as leads.
template string Required The name of the email template to send, exactly as it appears in Shape.
statuses list Optional Only email records with these statuses. Leave it out to include all statuses.
sources list Optional Only email records from these sources. Leave it out to include all sources.
created_date_start string Optional Only email records created on or after this date, as YYYY-MM-DD.
created_date_end string Optional Only email records created on or before this date, as YYYY-MM-DD.
assigned_user_ids list Optional Only email records assigned to these users, by user ID from Get Users. Leave it out to include records assigned to anyone.

Records must match every filter you send. Within a list, a record can match any value: for example, "statuses": ["New", "Attempting Contact"] includes records in either status.

Example request

{
  "record_type": "leads",
  "template": "September Rate Update",
  "statuses": ["New", "Attempting Contact"],
  "sources": ["Website", "Referral"],
  "created_date_start": "2026-09-01",
  "created_date_end": "2026-09-16",
  "assigned_user_ids": [1024, 1031]
}

Successful response

{
  "message": "Email Successfully Queued: September Rate Update",
  "status": 1,
  "total_records": 4
}
Field Description
message Confirms the send was queued, followed by the template name.
status 1 when the send was queued.
total_records How many records matched your filters and were queued to receive the email.
Emails are queued, not sent instantly. A successful response means the send started.