Helpdesk
RoadmapGo to MeltingSpot
English
English
  • To begin
    • 📝Introduction
    • 🗝️Key concepts
    • 👋Join a Spot
    • 🎯Create a Spot
  • Content of a Spot
    • 🏠Home page
    • ▶️Lives
      • ➕Create a live
      • ➕Create a replay
      • 👣Accessing the live's settings
      • ⚙️General settings
      • 🔓Privacy
      • 🎥Video Settings
      • ⚙️Live room settings
      • 💌Invitations & participants
      • 👥Manage guest groups
      • 🎙️Speakers
      • 📩Notifications
      • 🏷️Tags on lives
      • ✔️Register to a live
      • 📋Before starting a live
      • ⏸️Start a live
      • ⏯️Ending a live
      • 📊Live performance metrics
    • 🎓Courses
      • 📂Module
      • ➕Create a course
      • 👣Configuring steps
      • ⁉️Quiz
      • 🛣️Access course parameters
      • ⚙️General settings
      • 💌Invitations & participants
      • 👥Manage guest groups
      • 📩Notifications
      • ✏️Draft mode
      • 📋Take a course
    • 💬Discussions
      • 🔉Creating a channel
      • ⚙️Channel settings
      • ➕Adding and removing members of a channel
      • 🧰Forum
      • 👉Topics in Forums
      • ➕Adding and removing members of a secret forum
      • ⬆️Voting, sorting and searching in Topics
      • 📌Sharing, pinning and marking topic as closed
      • ⬇️Voting, sorting and pinning replies to a Topic
      • 🔔Forum notifications
      • 🖍️Writing a message
      • 👋Mentioning a member
      • ❌Editing or deleting a message
      • 🗣️Replying to a message
      • ❤️Reacting to a message
    • 📚Collections
      • 🆕Manage a collection
      • 🔐Managing members/groups of a private collection
      • 📃Create and delete a page
      • 🔗Add & remove a link
      • ✏️Draft mode
      • 🏷️Tags on documents
    • 👥Members directory
      • 📰Public profile of a member
      • 🤸‍♂️Members' activities
      • 🏷️Tags on members
    • 🗣️Direct messages
    • 🔍Search in Spot
  • Managing a Spot
    • ⚙️Accessing the settings
    • 📊Dashboard
      • 📈Overview
      • 🤿Activities
      • ▶️Lives
    • 👥Audience
      • 👥Members
        • 🎭Member's role
        • 🎓Member's status
        • 📩Invite new members
        • 🗃️Import members
        • 👀Track Registration Sources
        • 💬Bulk Message
        • 🌠Last activity date
        • 👾Custom properties
      • 🧑‍🤝‍🧑Groups
        • ✍️Static Group
        • 🤖Smart Group
      • 👤User rights
        • ⚙️Manage roles
        • 🧢Assign roles to members
        • 🤝Permissions
    • 🏷️Tags
    • 👀Moderation
    • ⚙️General settings
    • 🎨Customization
      • ✨Theme
      • 🏗️Modular Spot
      • 🧑‍💻Scripts
    • 📨Email notifications
    • ❓Registration form
    • 🔗Integrations
      • 🪝Webhooks
      • 🤖API Access
        • 🧑‍🏫REST API
        • 🔦Configuration
        • 🗃️Endpoints - Spot Members
        • 🗃️Endpoints - Lives
        • 🗃️Endpoints - Courses
        • 🗃️Endpoints - Channels
        • 🗃️Endpoints - Forums
        • 🗃️Endpoints - Topics
        • 🗃️Endpoints - Groups
        • 🗃️Endpoints - Tags
        • 🗃️Endpoints - Custom properties
        • 🗃️Endpoints - Search
        • 🗃️Endpoints - Notifications
    • 🧡HubSpot integration
    • 🔑Single Sign-On
    • 🧩Embed
    • 💁‍♂️Widget
      • 📚List of contents
      • 🎓Course
      • 📃Document
      • Page
      • 🧑‍🏫Implementation
  • User Settings
    • 🔔Notification management
      • 💌Email Digest
    • 👤Manage my profiles
    • 🙌Belonging to several Spots
    • 🔔Notification Center
  • Guides
    • 🧐Access MeltingSpot
    • ⏹️Add MeltingSpot to your phone/computer home screen
    • 🔥Create a HubSpot contact for each new Spot registration
    • ✨Notify the start of a live on Slack
    • 📅Send a google calendar invitation to new live participants
    • 🗒️Add new members of your Spot to a Google Sheet
    • ❔How to use the webhook Registration form answered
    • 🔗Embed a Google Form in a page of your Spot
    • 🐞Troubleshooting lives
    • 🐝Accessing your billing space
    • ❓FAQ
Propulsé par GitBook
Sur cette page

Cet article vous a-t-il été utile ?

  1. Managing a Spot
  2. Integrations
  3. API Access

Endpoints - Tags

PrécédentEndpoints - GroupsSuivantEndpoints - Custom properties

Dernière mise à jour il y a 5 mois

Cet article vous a-t-il été utile ?

List tags

Create a tag

Get a tag

Delete a tag

Update a tag

Assign multiple spot members to a tag

Unassign multiple spot members to a tag

List tagged members

Create multiple tags

🔗
🤖
🗃️
get

List tags

Paramètres de requête
pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

name[eq]stringOptionnel

Get a tag by a specific name

name[contains]stringOptionnel

Get a tag that contains this name

Réponses
200
Tags returned successfully
application/json
400
Malformed payload
get
GET /v1/tags HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "order": 1
    }
  ],
  "total": 1
}
get

Get a tag

Paramètres de chemin
tagIdstringRequis

The id of the tag

Réponses
200
Tag found and returned successfully
application/json
400
Malformed payload
404
Tag not found
get
GET /v1/tags/{tagId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "order": 1
}
delete

Delete a tag

Paramètres de chemin
tagIdstringRequis

The id of the tag

Réponses
204
Tag successfully deleted
400
Malformed payload
404
Tag not found
delete
DELETE /v1/tags/{tagId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

get

List Tagged members

Paramètres de chemin
tagIdstringRequis

The id of the tag

Paramètres de requête
pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

email[in]string[]Optionnel

The emails of spot member to include in the result

firstname[in]string[]Optionnel

The firstnames of spot member to include in the result

lastname[in]string[]Optionnel

The lastnames of spot member to include in the result

registrationDate[before]integerOptionnel

Spot members where registration date is before a specific date (Unix timestamp format)

registrationDate[after]integerOptionnel

Spot members where registration date is after a specific date (Unix timestamp format)

Réponses
200
Tagged members returned successfully
application/json
400
Malformed payload
get
GET /v1/tags/{tagId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "customRoleId": "text",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "total": 1
}
  • List tags
  • GET/v1/tags
  • Create a tag
  • POST/v1/tags
  • Get a tag
  • GET/v1/tags/{tagId}
  • Delete a tag
  • DELETE/v1/tags/{tagId}
  • Update a tag
  • PUT/v1/tags/{tagId}
  • Assign multiple spot members to a tag
  • POST/v1/tags/{tagId}/spotMembers~bulkAssign
  • Unassign multiple spot members to a tag
  • POST/v1/tags/{tagId}/spotMembers~bulkUnassign
  • List tagged members
  • GET/v1/tags/{tagId}/spotMembers
  • Create multiple tags
  • POST/v1/tags~bulkCreate
post

Create a tag

Corps
namestringRequis

Name of the tag

emojistringOptionnel

Emoji of the tag

Réponses
201
The tag has been successfully created
application/json
400
Malformed payload
post
POST /v1/tags HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "emoji": "text"
}
{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "order": 1
}
put

Update a tag

Paramètres de chemin
tagIdstringRequis

The id of the tag

Corps
namestringOptionnel

The name of the tag

emojistring | nullableOptionnel

The emoji of the tag

Réponses
200
Tag successfully updated
application/json
400
Malformed payload
404
Tag not found
put
PUT /v1/tags/{tagId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "emoji": "text"
}
{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "order": 1
}
post

Assign spot members to a tag

Paramètres de chemin
tagIdstringRequis

The id of the tag

Corps
spotMemberIdsstring[]Requis

The ids of the spotMembers to assign to the tag

Réponses
204
Spot members successfully assigned
400
Malformed payload
post
POST /v1/tags/{tagId}/spotMembers~bulkAssign HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

Aucun contenu

post

Unassign spot members to a tag

Paramètres de chemin
tagIdstringRequis

The id of the tag

Corps
spotMemberIdsstring[]Requis

The ids of the spotMembers to unassign to the tag

Réponses
204
Spot members successfully unassigned
400
Malformed payload
post
POST /v1/tags/{tagId}/spotMembers~bulkUnassign HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

Aucun contenu

post

Create multiple tags

Corps
namestringRequis

Name of the tag

emojistringOptionnel

Emoji of the tag

Réponses
201
Tags has been successfully created
application/json
400
Malformed payload
413
Payload is too large
post
POST /v1/tags~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 32

[
  {
    "name": "text",
    "emoji": "text"
  }
]
{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "order": 1
    }
  ],
  "failed": [
    {
      "name": "text",
      "emoji": "text"
    }
  ]
}