Skip to main content
POST
/
audience
/
broadcasts
Send Broadcast Email
curl --request POST \
  --url https://api.blink.store/v1/audience/broadcasts \
  --header 'Content-Type: application/json' \
  --header 'x-store-id: <api-key>' \
  --data '
{
  "name": "<string>",
  "subject": "<string>",
  "html": "<string>"
}
'
import requests

url = "https://api.blink.store/v1/audience/broadcasts"

payload = {
    "name": "<string>",
    "subject": "<string>",
    "html": "<string>"
}
headers = {
    "x-store-id": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-store-id': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', subject: '<string>', html: '<string>'})
};

fetch('https://api.blink.store/v1/audience/broadcasts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blink.store/v1/audience/broadcasts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'subject' => '<string>',
    'html' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-store-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.blink.store/v1/audience/broadcasts"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\"\n}")

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

	req.Header.Add("x-store-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.blink.store/v1/audience/broadcasts")
  .header("x-store-id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.blink.store/v1/audience/broadcasts")

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

request = Net::HTTP::Post.new(url)
request["x-store-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "broadcast_id": "<string>",
    "sent_count": 123,
    "audience_size": 123,
    "status": "<string>"
  }
}

Authorizations

x-store-id
string
header
required

Body

application/json
name
string
required
subject
string
required
html
string
required
recipients_type
enum<string>
required
Available options:
all,
repeat_customers

Response

201 - application/json

Broadcast email successfully sent and recorded.

data
object