Sending model

Example

{
  "id": 1000016,
  "audience_id": 106642,
  "status": "scheduled",
  "scheduled_at": "2020-09-18T09:28:59.918Z",
  "scheduled_with": {
    "in": "15 minutes",
    "type": "relative"
  },
  "created_at": "2020-09-18T09:13:59.937Z",
  "updated_at": "2020-09-18T09:13:59.937Z",
  "transmitted_at": "2020-09-18T09:13:59.937Z",
  "dispatches_count": 4912,
  "recipients": [
    {
      "member_id": 150,
      "msisdn": null,
      "email": null,
      "app_token": null,
      "properties": { "first_name": "Piotr" }
    }
  ]
}

Definition

Key	Type	Description
id	integer
audience_id	integer	ID of audience the sending is directed to
status	string	See: Sending status
scheduled_at	datetime	Time of sending execution
scheduled_with	Object	Params the sending has been scheduled with - See SendingSchedulePayload
dispatches_count	Number of dispatches, when sending has not been executed yet it's `null`
transmitted_at	datetime	Time of sending transmission
created_at	datetime	Time of creation
updated_at	datetime	Time of update
recipients	Recipient[]	Inline recipients the sending is directed to

Sending status

The Sending may have one of following statuses, which may be grouped into initial states, execution steps and the final outcomes:

initial states:

draft - When API client didn't't define the schedule (or has draft: true flag)

scheduled - When scheduled to be sent at specific time by API client

Sending may have status changed from draft to scheduled and vice versa, as long as the execution haven't started yet.

execution steps:

preparing - Building Dispatches for Recipients and Audience members

prepared - Dispatches are built, ready for transmission

transmitting - Dispatches are being transmitted

final outcomes:

transmitted - When the Dispatches have been transmitted

skipped - When no recipients could be resolved for it (for example, Audience may lose its members over time).

cancelled - When cancelled by API client at any point of execution (see: Sending cancellation.

failed - When the execution couldn't be finished in about 20 minutes after the desired time

Whenever Sending is cancelled or failed, it cannot be rescheduled again.

Example#

Definition#

Sending status#

Example

Definition

Sending status