Skip to navigation
API ReferenceMessages

Send a broadcast

View as MarkdownOpen in Claude

Sends one message to many participants on a study. Each of them gets a new conversation carrying the broadcast’s subject, topic and study, with the message as its first message. Replies stay in that conversation, between the participant and the sender.

The broadcast is saved as it was sent and never changes. The conversations are created in the background, so they can take a short while to appear.

Pass your own id to make sending safe to repeat. Sending again with an id you’ve already used returns that broadcast rather than sending it twice.

Every recipient must have a submission for the study, in any status. A broadcast can go to as many people as a bulk message, 4,000 by default, and going over returns a 400 that gives the limit. The study must belong to a workspace you are in. A study you can’t broadcast about returns 404, as does the endpoint while broadcasts aren’t enabled for the study’s workspace.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Request

This endpoint expects an object.
study_idstringRequired
The study the broadcast is about.
subjectstringRequired<=500 characters
Shown as the title of each recipient's conversation.
bodystringRequired10-10000 characters
The message, sent as the first message of each conversation.
recipient_idslist of stringsRequired
Participants with a submission for the study. Repeats are ignored.
audience_sourceenumRequired
Where the recipients were picked.
Allowed values:
idstringOptionalformat: "^[a-f0-9]{24}$"
An id you choose for the broadcast. Sending again with the same id returns the broadcast already sent. One is made for you if it's left out.
topicenum or nullOptional
Which of the fixed categories it falls under, if any.
workspace_idstringOptional
Send it as this workspace rather than as yourself. Must be the study's workspace, and requires workspace messaging.

Response

The broadcast
idstring
study_idstring
subjectstring
topicstring or null
bodystring
audience_sourcestring
recipient_countinteger
datetime_createddatetime

Errors

4XX
Client Request Error