PRprolific
messages

Send a message to a participant group

Changed on

Send a message to a participant group.

A group you can't view returns 404. Who can view a group follows the participant groups endpoints. If your access can't be checked right now, it returns 503.

post/api/v1/messages/participant-group/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/messages/participant-group/
  • Auth
    API key in header Authorization

Request body

participant_group_idstring required

A participant group ID

bodystring required

Message Body. Text is sanitised for safe storage and display.

study_idstring

A study ID

Response

The message has been sent

object required

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id send-message-to-participant-group removed and replaced with messages_SendMessageToParticipantGroup