# Send a message to multiple participants

POST https://api.prolific.com/api/v1/messages/bulk/
Content-Type: application/json

Send a message to multiple participants.

Reference: https://beta-docs.prolific.com/api-reference/messages/bulk-message-participants

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Send a message to multiple participants
  version: endpoint_messages.BulkMessageParticipants
paths:
  /api/v1/messages/bulk/:
    post:
      operationId: bulk-message-participants
      summary: Send a message to multiple participants
      description: Send a message to multiple participants.
      tags:
        - - subpackage_messages
      parameters:
        - name: Authorization
          in: header
          description: Header authentication of the form `undefined <token>`
          required: true
          schema:
            type: string
      responses:
        '204':
          description: The message has been sent
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Messages_BulkMessageParticipants_Response_204
        '400':
          description: Error
          content: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendBulkMessage'
components:
  schemas:
    SendBulkMessage:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: A list of participant ID's
        body:
          type: string
          description: Message Body. Text is sanitised for safe storage and display.
        study_id:
          type: string
          description: A study ID
      required:
        - ids
        - body
        - study_id
    Messages_BulkMessageParticipants_Response_204:
      type: object
      properties: {}

```

## SDK Code Examples

```python
import requests

url = "https://api.prolific.com/api/v1/messages/bulk/"

payload = {
    "ids": ["619e049f7648a4e1f8f3645b", "619e049f7648a4e1f8f3645c", "619e049f7648a4e1f8f3645d"],
    "body": "Thanks for participating in my study",
    "study_id": "6569ece7ca177d19117b1b95"
}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.prolific.com/api/v1/messages/bulk/';
const options = {
  method: 'POST',
  headers: {Authorization: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"ids":["619e049f7648a4e1f8f3645b","619e049f7648a4e1f8f3645c","619e049f7648a4e1f8f3645d"],"body":"Thanks for participating in my study","study_id":"6569ece7ca177d19117b1b95"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prolific.com/api/v1/messages/bulk/"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"619e049f7648a4e1f8f3645b\",\n    \"619e049f7648a4e1f8f3645c\",\n    \"619e049f7648a4e1f8f3645d\"\n  ],\n  \"body\": \"Thanks for participating in my study\",\n  \"study_id\": \"6569ece7ca177d19117b1b95\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prolific.com/api/v1/messages/bulk/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    \"619e049f7648a4e1f8f3645b\",\n    \"619e049f7648a4e1f8f3645c\",\n    \"619e049f7648a4e1f8f3645d\"\n  ],\n  \"body\": \"Thanks for participating in my study\",\n  \"study_id\": \"6569ece7ca177d19117b1b95\"\n}"

response = http.request(request)
puts response.read_body
```

```java
HttpResponse<String> response = Unirest.post("https://api.prolific.com/api/v1/messages/bulk/")
  .header("Authorization", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"619e049f7648a4e1f8f3645b\",\n    \"619e049f7648a4e1f8f3645c\",\n    \"619e049f7648a4e1f8f3645d\"\n  ],\n  \"body\": \"Thanks for participating in my study\",\n  \"study_id\": \"6569ece7ca177d19117b1b95\"\n}")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.prolific.com/api/v1/messages/bulk/', [
  'body' => '{
  "ids": [
    "619e049f7648a4e1f8f3645b",
    "619e049f7648a4e1f8f3645c",
    "619e049f7648a4e1f8f3645d"
  ],
  "body": "Thanks for participating in my study",
  "study_id": "6569ece7ca177d19117b1b95"
}',
  'headers' => [
    'Authorization' => '<apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
var client = new RestClient("https://api.prolific.com/api/v1/messages/bulk/");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"ids\": [\n    \"619e049f7648a4e1f8f3645b\",\n    \"619e049f7648a4e1f8f3645c\",\n    \"619e049f7648a4e1f8f3645d\"\n  ],\n  \"body\": \"Thanks for participating in my study\",\n  \"study_id\": \"6569ece7ca177d19117b1b95\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "ids": ["619e049f7648a4e1f8f3645b", "619e049f7648a4e1f8f3645c", "619e049f7648a4e1f8f3645d"],
  "body": "Thanks for participating in my study",
  "study_id": "6569ece7ca177d19117b1b95"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prolific.com/api/v1/messages/bulk/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```