ποΈEndpoints
All endpoints are divided into different sections:
SpotMembers
Lives
Channels
Forums
Topics
Search
Groups
Tags
Notifications
Dernière mise à jour
All endpoints are divided into different sections:
Dernière mise à jour
Delete a Live
The id of the Live
Live successfully deleted
Unlink a group from a live
The id of the Live
The id of the group
Group successfully unlink
Delete a channel
The id of the channel
Channel successfully deleted
Unlink a group from a channel
The id of the channel
The id of the group
Group successfully unlink
Delete a forum
The id of the forum
Forum successfully deleted
Delete a topic
The id of the forum
The id of the topic
Topic successfully deleted
Delete a group
The id of the group
Group successfully deleted
Delete a tag
The id of the tag
Tag successfully deleted
Add member to a channel
The id of the channel
An uuid representing the unique identifier of the spot member to add to channel
Member successfully added
Link a group
The id of the channel
The id of the group to link
Group linked successfully
Add member to a group
The id of the group
An uuid representing the unique identifier of the spot member to add to the group
Member successfully added
Link groups
The id of the channel
The ids of the groups to link
Groups linked successfully
Unlink groups from a channel
The id of the channel
The ids of the groups to link
Groups successfully unlink
Unlink groups from a live
The id of the Live
The ids of the groups to link
Groups successfully unlink
List Group members
The id of the group
Group members returned successfully
The items found
The total number of items found
Get a topic
The id of the forum
The id of the topic
Topic found and returned successfully
The id of the topic.
The name of the topic.
List Channel members
The id of the channel
Channel members returned successfully
The items found
The total number of items found
Link a group
The id of the Live
The id of the group to link
To send an email notification to each added member. Disable by default.
Group linked successfully
List Live speakers
The id of the Live
Live speakers returned successfully
The items found
The total number of items found
Link groups
The id of the Live
The ids of the groups to link
To send an email notification to each added member. Disable by default.
Groups linked successfully
Create a topic
The id of the forum
Name of the topic
Content of the topic (in Markdown)
Topic has been successfully created
The id of the topic.
The name of the topic.
Update a topic
The id of the forum
The id of the topic
Name of the topic
Content of the topic
Topic successfully updated
The id of the topic.
The name of the topic.
Get a tag
The id of the tag
Tag found and returned successfully
The id of the tag.
The name of the tag.
The emoji of the tag
The order of the tag.
Get a forum
The id of the forum
Forum found and returned successfully
The id of the forum.
The name of the forum.
The emoji of the forum
The description of the forum
Timestamp in ms of creation date
Get a group
The id of the group
Group found and returned successfully
The id of the group.
The name of the group.
The description of the group
The emoji of the group
The icon of the group
List topics
The id of the forum
Topics returned successfully
The items found
The total number of items found
Remove members from a channel
The id of the channel
An array of strings representing the unique identifiers of spot members to remove from channel
Members successfully removed
The number of members removed from the channel.
Add members to a group
The id of the group
An array of strings representing the unique identifiers of spot members to add to group
Members successfully added
The number of members added to the group.
Remove members from a group
ID of the group
An array of strings representing the unique identifiers of spot members to remove from group
Members successfully removed
The number of members removed from the group.
Create a tag
Name of the tag
Emoji of the tag
The tag has been successfully created
The id of the tag.
The name of the tag.
The emoji of the tag
The order of the tag.
List tags
Tags returned successfully
The items found
The total number of items found
Add members to a channel
The id of the channel
An array of strings representing the unique identifiers of spot members to add to channel
Members successfully added
The list of spot member id that were successfully added to the channel.
The list of spot member id that failed to be added to the channel.
Create a forum
Name of the forum
Description of the forum
Emoji of the forum
The forum has been successfully created
The id of the forum.
The name of the forum.
The emoji of the forum
The description of the forum
Timestamp in ms of creation date
Create a group
The name of the group
The description of the group
The emoji of the group
Group has been successfully created
The id of the group.
The name of the group.
The description of the group
The emoji of the group
The icon of the group
Get a channel
The id of the channel
Channel found and returned successfully
The id of the channel.
The name of the channel.
The emoji of the channel
The description of the channel.
The privacy of the channel.
Whether the channel will be auto-joined by new members.
Whether the channel will show its members.
List forums
Forums returned successfully
The items found
The total number of items found
List groups
Groups returned successfully
The items found
The total number of items found
Update a tag
The id of the tag
The name of the tag
The emoji of the tag
Tag successfully updated
The id of the tag.
The name of the tag.
The emoji of the tag
The order of the tag.
Get unread notifications count
The id of the Spot member
Counter of unread notification returned successfully
Sum of counters
Unread notifications by types
Update a channel
The id of the channel
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
Channel successfully updated
The id of the channel.
The name of the channel.
The emoji of the channel
The description of the channel.
The privacy of the channel.
Whether the channel will be auto-joined by new members.
Whether the channel will show its members.
Link a group
The id of the Live
Group returned successfully
The items found
The total number of items found
list a group
The id of the channel
Group returned successfully
The items found
The total number of items found
Invite a spot member
The email of the spot member
Set to true to send notification mail to each invited members
Spot member has been successfully invited
The id of the spot member.
The id of the spot.
The id of the user.
The email of the spot member.
The title of the spot member.
The role of the spot member.
The firstname of the spot member.
The lastname of the spot member.
List channels
Channels returned successfully
The items found
The total number of items found
Update a forum
The id of the forum
The name of the forum
The description of the forum
The emoji of the forum
Forum successfully updated
The id of the forum.
The name of the forum.
The emoji of the forum
The description of the forum
Timestamp in ms of creation date
Update a group
The id of the group
The name of the group
The description of the group
The emoji of the group
Group successfully updated
The id of the group.
The name of the group.
The description of the group
The emoji of the group
The icon of the group
Create multiple channels
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
Channels has been successfully created
The channels that were created.
The channels that failed to be created.
Mark notifications as read
The id of the Spot member
Filters on notifications to include
Notifications successfully marked as read
The id of the notification.
The user id of the notification.
The log id of the notification.
To know if notification was read
The creation date of the notification.
Create multiple tags
Name of the tag
Emoji of the tag
Tags has been successfully created
The tags that were created.
The tags that failed to be created.
List Spot members
Spot members returned successfully
The items found
The total number of items found
Create a channel
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
Channel has been successfully created
The id of the channel.
The name of the channel.
The emoji of the channel
The description of the channel.
The privacy of the channel.
Whether the channel will be auto-joined by new members.
Whether the channel will show its members.
Create multiple forums
Name of the forum
Description of the forum
Emoji of the forum
Forums has been successfully created
The forums that were created.
The forums that failed to be created.
Create multiple groups
The name of the group
The description of the group
The emoji of the group
Groups has been successfully created
The groups that were created.
The groups that failed to be created.
Invite a member as Live participant
The id of the Live
Member to invite as Live participant from email address or existing Spot member ID
The Spot member ID on the initiative of the invitation
Set to true to send notification mail to each invited members
Member has been successfully invited
The id of the participant.
The Live id of the participant.
The status of the participant.
The type of the participant.
The invitation date of the participant.
The registration date of the participant.
The highlight value of the participant.
The metrics of the participant.
Create multiple topics
ID of the forum
Name of the topic
Content of the topic (in Markdown)
Topics has been successfully created
The channels that were created.
The channels that failed to be created.
Update a spot member
The id of the spotMember
The first name of the spot member
The last name of the spot member
The title of the spot member
The role of the spot member
The status of the spot member
Spot member successfully updated
The id of the spot member.
The id of the spot.
The id of the user.
The email of the spot member.
The title of the spot member.
The role of the spot member.
The firstname of the spot member.
The lastname of the spot member.
List notifications
The id of the Spot member
Notifications returned successfully
The items found
Indicate if more items are available
Search for resources in the spot
Search results
The items found
The total number of items found
Invite multiple members as Live participant
The id of the Live
The Spot member ID on the initiative of the invitation
Set to true to send notification mail to each invited members
Members to invite
Members has been successfully invited
The id of the participant.
The Live id of the participant.
The status of the participant.
The type of the participant.
The invitation date of the participant.
The registration date of the participant.
The highlight value of the participant.
The metrics of the participant.
List Live participants
The id of the Live
Live participants returned successfully
The items found
The total number of items found
Invite a member as Live speaker
The id of the Live
Member to invite as Live participant from email address or existing Spot member ID
The Spot member ID on the initiative of the invitation
Set to true to highlight the Speaker. False by default
Set to true to grant Host rights to the Speaker. False by default
Set to true to send notification mail to each invited members
Member has been successfully invited
The id of the participant.
The Live id of the participant.
The status of the participant.
The type of the participant.
The invitation date of the participant.
The registration date of the participant.
The highlight value of the participant.
The metrics of the participant.
Invite multiple spot members
The emails of members to invite
Set to true to send notification mail to each invited members
Spot members has been successfully invited
The spot members that were created.
The spot members that failed to be created.
List Lives
Lives returned successfully
The items found
The total number of items found
Create a Live
The title of the Live
Description of the Live (in Markdown)
The Spot member host of the Live
Start date of the Live (Unix timestamp format)
End date of the Live (Unix timestamp format)
Solution of the Live
BuiltIn type of the Live (if solution is BuiltIn)
Video URL of the Live (if solution is Youtube or Vimeo)
The chat visibility on the Live
The participant list visibility on the Live
The Live visibility
Who kind of members can participate to the Live
Active the record on the Live
Live has been successfully created
The id of the Live.
The title of the Live.
The startDate of the Live.
The endDate of the Live.
The metrics of the Live.
The description of the Live.
The status of the Live.
The computed status of the Live.
The solution of the Live.
The privacy of the Live.
The configuration of the Live.
The builtIn type of the Live.
The video URL of the Live.
The creation date of the Live.
The spot ID of the Live.
The builtIn configuration of the Live.
Update a Live
The id of the Live
The title of the Live
Description of the Live (in Markdown)
Start date of the Live (Unix timestamp format)
End date of the Live (Unix timestamp format)
The chat visibility on the Live
The participant list visibility on the Live
The Live visibility
Who kind of members can participate to the Live
Solution of the Live
BuiltIn type of the Live (if solution is BuiltIn)
Active the record on the Live
Make available the record of the Live
Video URL of the Live (if solution is Youtube or Vimeo)
Video URL of the Live (if solution is Youtube or Vimeo)
Live successfully updated
The id of the Live.
The title of the Live.
The startDate of the Live.
The endDate of the Live.
The metrics of the Live.
The description of the Live.
The status of the Live.
The computed status of the Live.
The solution of the Live.
The privacy of the Live.
The configuration of the Live.
The builtIn type of the Live.
The video URL of the Live.
The creation date of the Live.
The spot ID of the Live.
The builtIn configuration of the Live.
Get a Live
The id of the Live
Live found and returned successfully
The id of the Live.
The title of the Live.
The startDate of the Live.
The endDate of the Live.
The metrics of the Live.
The description of the Live.
The status of the Live.
The computed status of the Live.
The solution of the Live.
The privacy of the Live.
The configuration of the Live.
The builtIn type of the Live.
The video URL of the Live.
The creation date of the Live.
The spot ID of the Live.
The builtIn configuration of the Live.
Get a spot member
The id of the spotMember
Spot member returned successfully
The id of the spot member.
The id of the spot.
The id of the user.
The email of the spot member.
The title of the spot member.
The role of the spot member.
The firstname of the spot member.
The lastname of the spot member.
Invite multiple members as Live speaker
The id of the Live
The Spot member ID on the initiative of the invitation
Set to true to highlight the Speaker.
Set to true to grant Host rights to the Speaker.
Set to true to send notification mail to each invited members
Spot members to invite as Live speaker
Members has been successfully invited
The id of the participant.
The Live id of the participant.
The status of the participant.
The type of the participant.
The invitation date of the participant.
The registration date of the participant.
The highlight value of the participant.
The metrics of the participant.