Relesys API Docs

v1.1

https://api.relesysapp.net/api/v1.1

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax

Endpoints

Concept

Markdown Syntax

This document describes extensions made to the standard Markdown syntax to support additional features: hashtags, mentions, and media embedding.

Important! In order to create an empty line, please use <br>.

Example

Markdown
An empty line is added here\n<br>in this text.

Rendered Output (Example)

HTML
An empty line is added here

in this text.

Hashtags

markdown
!{hashtag}(hashtagName)

!{hashtag} is a reserved keyword indicating that a hashtag is being explicitly embedded.
(hashtagName) is the name of the hashtag (with or without the leading # symbol). It can include letters, numbers, underscores, and hyphens.

Examples

Markdown
!{hashtag}(celebrate)
!{hashtag}(#birthday)

Rendered Output (Examples)

HTML
#celebrate
#birthday

Department Mentions

Markdown
!{department}[Department Name](departmentId)

!{department} is a reserved keyword indicating that a department mention is being explicitly embedded.
[Department Name] is the name of the department to be mentioned (with or without the leading @ symbol).
(departmentId) the department's unique identifier (string / guid).

Examples

Markdown
!{department}[Sales Operations](5ed2c583-8cef-4c78-b84c-3a2dc52c2a0c)
!{department}[@Retail Support](d8cfeb83-10a3-48ff-b263-e73470c0d601)

Rendered Output (Examples)

HTML
@Sales Operations
@Retail Support

User Mentions

Markdown
!{user}[User Name](userId)

!{user} is a reserved keyword indicating that a user mention is being explicitly embedded.
[User Name] is the name of the user to be mentioned (with or without the leading @ symbol).
(userId) the user's unique identifier (string / guid).

Examples

Markdown
!{user}[John Doe](486b1786-eaad-44fa-a959-1310ada63d5a)
!{user}[@Jane Doe](e19fcbeb-7d46-4a26-adc5-274515b30232)

Rendered Output (Examples)

HTML
@John Doe
@Jane Doe

User Group Mentions

Markdown
!{user-group}[User Group Name](userGroupId)

!{user-group} is a reserved keyword indicating that a user group mention is being explicitly embedded.
[User Group Name] is the name of the user group to be mentioned (with or without the leading @ symbol).
(userGroupId) the user group's unique identifier (string / guid).

Examples

Markdown
!{user-group}[Administrator](99b9915e-1900-4d51-9ce0-a00d7a12a8da)
!{user-group}[@Content Creator](b504feac-46b7-4926-bffd-fda8cee518bb)

Rendered Output (Examples)

HTML
@Administrator
@Content Creator

Images

We support embedding images of these file types: .gif, .jfif, .jpeg, .jpg, .png.
Images can be embedded in two ways, using:
1. standard syntax and providing image URL

Markdown
![Image description](imageUrl)

2. our extended syntax and providing an image ID
Markdown
!{image}(imageId)

!{image} is a reserved keyword indicating that an image is being explicitly embedded.
(imageId) the image's unique identifier (string / guid).

Examples

Markdown
![Some image description](https://someimageurl.com/someimage.jpg)
!{image}(015fd237-042f-41f6-83e4-e46f1df0d09d)

Video

We support embedding videos of these file types: .avi, .m4v, .mov, .mp4, .mpeg, .mpg, .webm.
Video files can be embedded using a video ID.

Markdown
!{video}(videoId)

!{video} is a reserved keyword indicating that a video is being explicitly embedded.
(videoId) the video's unique identifier (string / guid).

Example

Markdown
!{video}(7d8c0669-8765-45d7-8e0d-64281929424e)