Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Emails::Broadcasts::SendAction

Fetch Send Action

Retrieve a single send action and its current async delivery progress. Compare performed_count to target_count to determine how far along delivery is. completed_at is set when delivery finishes. When accessing the API through an OAuth connection from a third-party platform, this endpoint is restricted to trusted developer platforms. If you are using your own API key, you can access this endpoint directly.

get/emails/broadcasts/send_actions/{id}

Path parameters

idstring required

Response

OK

idinteger

Send Action ID

public_idstring nullable

Send Action public ID

workspace_idinteger

Workspace ID

send_type'default' | 'split_test_main' | 'split_test_variant' | 'split_test_winner' | 'send_in_contacts_time_zone' | 'schedule_send_in_contacts_time_zone'

The delivery strategy used for this send action.

target_idsinteger[] nullable

Array of broadcast IDs targeted by this send action. For a standard broadcast send, this contains the single broadcast ID being delivered.

target_countinteger nullable

Total number of contacts targeted by this send action. null until the async job has resolved the audience count.

performed_countinteger nullable

Number of contacts processed so far. Poll alongside target_count to track async delivery progress.

scheduled_forstring date-time nullable

Datetime the send is scheduled to begin. Reflects the send_at passed at creation, adjusted to the workspace time zone. null for immediate sends.

started_atstring date-time nullable

Datetime the async delivery job began processing contacts. null until the job has started.

completed_atstring date-time nullable

Datetime the async delivery job finished. null until delivery is complete.

created_by_idinteger nullable

Reserved; null in most cases. The member who triggered the send is recorded in approved_by_id instead.

approved_by_idinteger nullable

ID of the workspace membership that created/approved this send action — the member that triggered the send. Populated for API-created sends.

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

broadcast_idinteger nullable

The ID of the email broadcast being delivered. Convenience field derived from target_ids[0].

Example response

{
  "id": 1,
  "public_id": "aB3cD4",
  "workspace_id": 42000,
  "send_type": "default",
  "target_ids": [
    7
  ],
  "target_count": 1500,
  "performed_count": 750,
  "scheduled_for": null,
  "started_at": "2025-06-01T18:00:05.000Z",
  "completed_at": null,
  "created_by_id": null,
  "approved_by_id": 3,
  "created_at": "2025-06-01T17:59:00.000Z",
  "updated_at": "2025-06-01T18:00:05.000Z",
  "broadcast_id": 7
}