🗃️Endpoints - Custom properties

List 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
}

Modify the value of a custom property for a member

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
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"
}

Modify or add multiple custom property values for a member

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
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"
  }
]

Dernière mise à jour

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