🗃️Endpoints - Custom properties

List custom property values for a member

Get custom properties values linked to a spot member

GEThttps://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues

Path parameters

spotMemberId*string

The id of the spotMember

Query parameters

Response

200

Custom properties value returned successfully

Body

application/json

items*array of CustomPropertyValueApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Modify the value of a custom property for a member

Update custom property values linked to a spot member

PUThttps://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues/{customPropertySlug}

Path parameters

spotMemberId*string

The id of the spotMember

customPropertySlug*string

The slug of the customProperty

Body

application/json

value*one of

Value of the custom property

stringnumberbooleanarray of string

Response

200400404

Custom property value updated successfully

Body

application/json

customPropertyId*string

The id of the custom property

customPropertyLabel*string

The label of the custom property

customPropertySlug*string

The slug of the custom property

customPropertyDescription*string

The description of the custom property

customPropertyType*enum

The type of the custom property

TextBooleanNumberSingleSelectMultipleSelectDate

possibleValues*nullable array of string

The possible values of the custom property

value*one of

The values of the custom property

stringnumberbooleanarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues/{customPropertySlug}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": "text"
    }),
});
const data = await response.json();

Response

200

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

Modify or add multiple custom property values for a member

Upsert custom properties values linked to a spot member

POSThttps://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues~bulkUpsert

Path parameters

spotMemberId*string

The id of the spotMember

Body

application/json

value*one of

Value of the custom property

stringnumberbooleanarray of string

customPropertySlug*string

The slug of the custom property

Response

200400404

Custom properties values upsert successfully

Body

application/json

customPropertyId*string

The id of the custom property

customPropertyLabel*string

The label of the custom property

customPropertySlug*string

The slug of the custom property

customPropertyDescription*string

The description of the custom property

customPropertyType*enum

The type of the custom property

TextBooleanNumberSingleSelectMultipleSelectDate

possibleValues*nullable array of string

The possible values of the custom property

value*one of

The values of the custom property

stringnumberbooleanarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues~bulkUpsert', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "value": "text",
        "customPropertySlug": "text"
      }
    ]),
});
const data = await response.json();

Response

200

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