Docs

GET /broadcasts/{id}

One broadcast.

Parameters

  • id path · string · required

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
archived_atstring | nullyes
contentobject | nullyes
created_atstringyes
from_addressstring | nullyes
idstringyes
namestringyes
scheduled_atstring | nullyes
segment_idstring | nullyes
sent_atstring | nullyes
sent_countintegeryes
statusstringyes
subjectstring | nullyes
template_idstring | nullyes
updated_atstringyes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.