Skip to main content
POST
/
v1
/
admin
/
notifications
/
staff
/
{staffId}
/
send
Send notification to staff
curl --request POST \
  --url http://localhost:3000/v1/admin/notifications/staff/{staffId}/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "body": "<string>",
  "type": "system",
  "data": {},
  "skipPreferenceCheck": false
}
'
import requests

url = "http://localhost:3000/v1/admin/notifications/staff/{staffId}/send"

payload = {
    "title": "<string>",
    "body": "<string>",
    "type": "system",
    "data": {},
    "skipPreferenceCheck": False
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    body: JSON.stringify('<string>'),
    type: 'system',
    data: {},
    skipPreferenceCheck: false
  })
};

fetch('http://localhost:3000/v1/admin/notifications/staff/{staffId}/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/v1/admin/notifications/staff/{staffId}/send",
  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([
    'title' => '<string>',
    'body' => '<string>',
    'type' => 'system',
    'data' => [
        
    ],
    'skipPreferenceCheck' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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 := "http://localhost:3000/v1/admin/notifications/staff/{staffId}/send"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"type\": \"system\",\n  \"data\": {},\n  \"skipPreferenceCheck\": false\n}")

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

	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("http://localhost:3000/v1/admin/notifications/staff/{staffId}/send")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"type\": \"system\",\n  \"data\": {},\n  \"skipPreferenceCheck\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/admin/notifications/staff/{staffId}/send")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"type\": \"system\",\n  \"data\": {},\n  \"skipPreferenceCheck\": false\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "sentCount": 123,
  "failedCount": 123,
  "errors": [
    "<string>"
  ]
}

Path Parameters

staffId
string<uuid>
required

Body

application/json
title
string
required
body
string
required
type
string
default:system
data
object
skipPreferenceCheck
boolean
default:false

Response

200 - application/json

Notification send result

success
boolean
required
sentCount
number
required
failedCount
number
required
errors
string[]
required