PRprolific
messages

Get a broadcast

Changed on

A broadcast as it was sent, with how many recipients have replied. List its conversations with GET /api/v1/conversations and its broadcast_id.

A broadcast that wasn't sent from your account returns 404. Pass workspace_id for one sent from a workspace you're in.

get/api/v1/broadcasts/{broadcast_id}/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/broadcasts/{broadcast_id}/
  • Auth
    API key in header Authorization

Path parameters

broadcast_idstring required

The broadcast's id, as returned when it was sent.

Query parameters

workspace_idstring

The workspace the broadcast was sent from. You must belong to it.

Response

The broadcast

idstring required
study_idstring required
subjectstring required
topicstring nullable required
bodystring required
audience_source'submissions' | 'PARTICIPANT_GROUP' | 'TYPED_IDS' | 'MESSAGES' required
recipient_countinteger required
datetime_createdstring date-time required
replied_countinteger required

How many recipients have replied. Your own follow-ups don't count.

Changes

  • 0eeae21e89feRevision changes
    • warning

      added the new MESSAGES enum value to the response property for the response status

  • 498c9e20b1ceRevision changes
    • warning

      added the new TYPED_IDS enum value to the response property for the response status