Relesys API Docs

Endpoints

Calendar
- Categories
  - Get Categories GET
- Events
  - Get Event GET
  - Get Events GET
Communication
- Messages
  - Send Message POST
- Notifications
  - Get Channels GET
  - Send Notifications POST
- Templates
  - Get Template GET
  - Get Templates GET
Content
- Categories
  - Get Content Categories GET
  - Get Content Category By Id GET
- Comments
  - Reactions
    - Get Comment Reactions GET
  - Get Comment By Id GET
  - Get Comments GET
- Reactions
  - Get Content Reactions GET
Data Lists
- Custom Fields
  - Get Custom Field GET
  - Get Custom Fields GET
- Items
  - Get Data List Item GET
  - Get Data List Items GET
- Get Data List GET
- Get Data Lists GET
Global
- Cultures
  - Get Cultures GET
- Time Zones
  - Get Time Zones GET
Highscores
- Levels
  - Get Level GET
  - Get Levels GET
- Points
  - Aggregated
    - Get Departments' Total Points GET
    - Get Users' Total Points GET
- Get GET
- List GET
KPI Management
- Data Points
- Data Sets
  - Get Data Set GET
  - Get Data Sets GET
Media
- Get Media By Id GET
Service Form
- Forms
  - Answer Feedback
    - Get GET
    - List GET
  - Answer Feedback Comments
    - Get GET
    - List GET
  - Answers
    - Get GET
    - List GET
  - Field Groups
    - Get GET
    - List GET
  - Fields
    - Get GET
    - List GET
  - Filling Comments
    - Get GET
    - List GET
  - Filling Feedback
    - Get GET
    - List GET
  - Filling Feedback Comments
    - Get GET
    - List GET
  - Filling Reactions
    - Get GET
    - List GET
  - Fillings
    - Get GET
    - List GET
  - Pages
    - Get GET
    - List GET
  - Performance Ranges
    - Get GET
    - List GET
  - Score Categories
    - Get GET
    - List GET
  - Stage Comments
    - Get GET
    - List GET
  - Stage Reviews
    - Get GET
    - List GET
  - Stages
    - Get GET
    - List GET
  - Get GET
  - List GET
- Modules
  - Get GET
  - List GET
Sessions
- Aggregated
  - Get Departments Aggregated GET
  - Get Devices Aggregated GET
- Get Sessions GET
Training
- Courses
  - Get Course Participations GET
  - Get Courses GET
- Lessons
- Modules
- Phases
  - Get Phases GET
User Management
- Custom Fields
  - Get User Custom Fields GET
- Departments
- User Groups
- Users

Messages

Send Message

POST /communication/messages/{userId}/send

https://api.relesysapp.net/api/v1.2/communication/messages/{userId}/send

Sends a Message to the user.

Please read the information below carefully, so you know how this endpoint operates.

deliveryMethod - Decides how to attempt to send out the message. If not provided, the request will not continue.
- Parameters: "sms", "email" or "both"

communicationTemplateId - If provided will look for the message to be sent out based on the Id provided. A list of available Communication Templates can be found under Communication -> Templates.

messageType - If communicationTemplateId is not provided, this will be looked for based on the 3 options below. These settings are chosen in the Relesys Portal.
- Parameters: "welcome", "logininfo" or "forgottenpassword"

messageBody - If none of the 2 options above are provided, this will be used to create a custom message.
- The body for email is HTML encoded and for SMS it is ASCII encoded.

Scopes: relesys.api, relesys.api:write, relesys.api.users, relesys.api.users:write

URL Path

userId

string / guid

The user's unique identifier

required

Request Body

application/json

object
communicationTemplateId	string / guid			optional
deliveryMethod	string			required
⯈ messageBody	object			optional
⯈ email	object			optional
body	string			optional
subject	string			optional
⯈ sms	object			optional
body	string			optional
messageType	string			optional

Responses

application/json

There is no body for this response