Skip to content

Messaging

These end points allow you to broadcast portal messages to either all of your customers or only given customers and get view statistics afterwards. Only single message at a time is supported for both all companies (broadcast) and a single company.

Operations

Set new message

Request

Adds new message to system as either broadcast or alternatively for specific customers. Replaces any existing message of that type.

POST https://partners.zoined.com/api/messaging

Security
partnerToken
Query
customerArray of strings

Optional customer IDs to apply the operation to specific partner companies only.

Example:customer=company_a
Bodyapplication/jsonrequired
titlestringrequired

Message title. Only very basic formatting html allowed.

Example:"Important message"
messagestringrequired

Message content. Only very basic formatting html allowed.

Example:"Message content here"
start_datestring, (date)

Date when to start showing the message

Example:"2020-01-01"
end_datestring, (date)

Date when to stop showing the message.

Example:"2020-01-31"
rolestring

Required role for users message is to be shown. Either user or admin.

Enum:"user""admin"
Example:"user"
curl -i -X POST \
  'https://zone-api.zoined.com/_mock/api/messaging?customer=company_a' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Important message",
    "message": "Message content here",
    "start_date": "2020-01-01",
    "end_date": "2020-01-31",
    "role": "user"
  }'

Responses

When message has been deleted successfully.