Send a broadcast message to multiple users (backward compatible)
Permissions: MultiUnit, Administrator, Unit users.
Headers
- Type: stringD
C Key The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.
Body·
Parameters for recipients and message
- Type: array of string | nullFormat: uuidLocal
Employee I Ds - Type: string | nullMessagemax length:500
- Type: array of integer | nullFormat: int32Unit
I Ds
Responses
Request Example for post/v2/Broadcast
curl /v2/Broadcast \
--request POST \
--header 'Content-Type: application/json-patch+json' \
--header 'DCKey: YOUR_SECRET_TOKEN' \
--data '{
"LocalEmployeeIDs": [
"C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
],
"UnitIDs": [
1
],
"Message": null
}'
{
"ChatID": null,
"ChatEmployees": [
{
"ShiftWorksUserID": null,
"FirstName": null,
"LastName": null,
"IsDeleted": true
}
],
"IsReadOnly": true,
"UnitID": null,
"ImagesEnabled": true
}