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 - Custom properties

PrécédentEndpoints - TagsSuivantEndpoints - Search

Dernière mise à jour il y a 3 mois

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

List custom property values for a member

Modify the value of a custom property for a member

Modify or add multiple custom property values for a member

🔗
🤖
🗃️
get

Get custom properties values linked to a spot member

Paramètres de chemin
spotMemberIdstringRequis

The id of the spotMember

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

Réponses
200
Custom properties value returned successfully
application/json
get
GET /v1/spotMembers/{spotMemberId}/customPropertiesValues HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
200

Custom properties value returned successfully

{
  "items": [
    {
      "customPropertyId": "text",
      "customPropertyLabel": "text",
      "customPropertySlug": "text",
      "customPropertyDescription": "text",
      "customPropertyType": "Text",
      "possibleValues": [
        "text"
      ],
      "value": "text"
    }
  ],
  "total": 1
}
  • List custom property values for a member
  • GET/v1/spotMembers/{spotMemberId}/customPropertiesValues
  • Modify the value of a custom property for a member
  • PUT/v1/spotMembers/{spotMemberId}/customPropertiesValues/{customPropertySlug}
  • Modify or add multiple custom property values for a member
  • POST/v1/spotMembers/{spotMemberId}/customPropertiesValues~bulkUpsert
put

Update custom property values linked to a spot member

Paramètres de chemin
spotMemberIdstringRequis

The id of the spotMember

customPropertySlugstringRequis

The slug of the customProperty

Corps
valueone ofRequis

Value of the custom property

stringOptionnel
ou
numberOptionnel
ou
booleanOptionnel
ou
string[]Optionnel
Réponses
200
Custom property value updated successfully
application/json
400
Malformed payload
404
Custom property not found
put
PUT /v1/spotMembers/{spotMemberId}/customPropertiesValues/{customPropertySlug} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}
{
  "customPropertyId": "text",
  "customPropertyLabel": "text",
  "customPropertySlug": "text",
  "customPropertyDescription": "text",
  "customPropertyType": "Text",
  "possibleValues": [
    "text"
  ],
  "value": "text"
}
post

Upsert custom properties values linked to a spot member

Paramètres de chemin
spotMemberIdstringRequis

The id of the spotMember

Corps
valueone ofRequis

Value of the custom property

stringOptionnel
ou
numberOptionnel
ou
booleanOptionnel
ou
string[]Optionnel
customPropertySlugstringRequis

The slug of the custom property

Réponses
200
Custom properties values upsert successfully
application/json
400
Malformed payload
404
Custom property not found
post
POST /v1/spotMembers/{spotMemberId}/customPropertiesValues~bulkUpsert HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 46

[
  {
    "value": "text",
    "customPropertySlug": "text"
  }
]
[
  {
    "customPropertyId": "text",
    "customPropertyLabel": "text",
    "customPropertySlug": "text",
    "customPropertyDescription": "text",
    "customPropertyType": "Text",
    "possibleValues": [
      "text"
    ],
    "value": "text"
  }
]