🗃️Endpoints - Custom properties

List custom property values for a member

get

Get custom properties values linked to a spot member

Path parameters

spotMemberIdstringrequired

The id of the spotMember

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues'

200

200

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

Custom properties value returned successfully

Modify the value of a custom property for a member

put

Update custom property values linked to a spot member

Path parameters

spotMemberIdstringrequired

The id of the spotMember

customPropertySlugstringrequired

The slug of the customProperty

Body

valueone ofrequired

Value of the custom property

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues/{customPropertySlug}' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "text"
  }'

200

400

404

200

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

Custom property value updated successfully

Modify or add multiple custom property values for a member

post

Upsert custom properties values linked to a spot member

Path parameters

spotMemberIdstringrequired

The id of the spotMember

Body

valueone ofrequired

Value of the custom property

customPropertySlugstringrequired

The slug of the custom property

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues~bulkUpsert' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "value": "text",
      "customPropertySlug": "text"
    }
  ]'

200

400

404

200

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

Custom properties values upsert successfully