internal
release-email

Send Internal Test Broadcast

Changed on

Broadcast the draft to the staff segment, without consuming the month.

post/api/v1/internal/release-email/digests/{digest_id}/internal-test-broadcast

Request

  • Base URL
    https://api.maia-analytics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maia-analytics.com/api/v1/internal/release-email/digests/{digest_id}/internal-test-broadcast
  • Auth
    HTTP bearer

Path parameters

digest_idstring uuid required

Response

Successful Response

idstring uuid required
month_startstring date required
covers_startstring date nullable required
covers_endstring date nullable required
subjectstring required
preheaderstring nullable required
body_markdownstring required
status'draft' | 'sending' | 'sent' required

Where a digest sits between editable and shipped.

SENDING exists so the claim on a send can be taken before Resend is called: the broadcast is the irreversible step, and a status that only changed after it returned would let a double click or a retry mail every customer twice.

last_test_sent_atstring date-time nullable required
updated_atstring date-time required
sent_atstring date-time nullable required
recipient_countinteger nullable required
resend_broadcast_idstring nullable required
internal_test_broadcast_idstring nullable required
internal_test_sent_atstring date-time nullable required
is_sentboolean required
is_lockedboolean required
is_test_send_currentboolean required

Changes

  • ba2b8d962161Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status