🗃️Endpoints - Spot Members

Invite a Spot member

Invite a spot member

post

/v1/spotMembers

Body

emailstringrequired

The email of the spot member

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/spotMembers' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","withEmailNotification":false}'

201

400

201

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "customRoleId": "text",
  "firstname": "text",
  "lastname": "text",
  "warnings": 1,
  "role": "Member",
  "status": "Accepted",
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Spot member has been successfully invited

Invite multiple Spot members

Invite multiple spot members

post

/v1/spotMembers~bulkInvite

Body

withEmailNotificationboolean

Set to true to send notification mail to each invited members

emailsstring[]

The emails of members to invite

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/spotMembers~bulkInvite' \
  --header 'Content-Type: application/json' \
  --data '{"withEmailNotification":false,"emails":[null]}'

201

400

413

201

{
  "created": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "customRoleId": "text",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "role": "Member",
      "status": "Accepted",
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "failed": [
    {
      "email": "text",
      "firstname": "text",
      "lastname": "text",
      "title": "text",
      "avatarUrl": "text",
      "role": "Member",
      "lang": "en",
      "theme": "light",
      "timezone": "Africa/Abidjan"
    }
  ]
}

Spot members has been successfully invited

Get custom form answers for a Spot member

Get custom form answers for a spot member

get

/v1/spotMembers/{spotMemberId}/customFormAnswers

Path parameters

spotMemberIdstringrequired

The id of the spotMember

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

questionLabel[contains]string

The question label of custom form answers to include in the result

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "total": 1,
  "items": [
    {
      "questionId": "text",
      "questionLabel": "text",
      "visibility": "text",
      "order": 1,
      "isRequired": true,
      "type": "Description",
      "possibleAnswers": [
        "text"
      ],
      "answers": [
        "text"
      ]
    }
  ]
}

Custom form answers returned successfully

Update a Spot member

Update a spot member

put

/v1/spotMembers/{spotMemberId}

Path parameters

spotMemberIdstringrequired

The id of the spotMember

Body

firstnamestring

The first name of the spot member

lastnamestring

The last name of the spot member

titlestring

The title of the spot member

avatarUrlobject | nullable

customRoleIdstring | nullable

The custom role ID of spot member

rolestring · enum

The role of the spot member

Options: Member, Admin

statusstring · enum

The status of the spot member

Options: Accepted, Rejected, Deactivated

embedBaseUrlsobject

The custom embed base URLs of the spot member.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}' \
  --header 'Content-Type: application/json' \
  --data '{"avatarUrl":{},"role":"Member","status":"Accepted","embedBaseUrls":{}}'

200

400

404

200

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "customRoleId": "text",
  "firstname": "text",
  "lastname": "text",
  "warnings": 1,
  "role": "Member",
  "status": "Accepted",
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Spot member successfully updated

Get a Spot member

Get a spot member

get

/v1/spotMembers/{spotMemberId}

Path parameters

spotMemberIdstringrequired

The id of the spotMember

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "customRoleId": "text",
  "firstname": "text",
  "lastname": "text",
  "warnings": 1,
  "role": "Member",
  "status": "Accepted",
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Spot member returned successfully

List Spot members

List Spot members

get

/v1/spotMembers

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

email[in]string[]

The emails of spot member to include in the result

firstname[in]string[]

The firstnames of spot member to include in the result

lastname[in]string[]

The lastnames of spot member to include in the result

role[in]string · enum[]

The roles of spot member to include in the result

customRoleId[eq]string

The custom role ID of Spot member

status[in]string · enum[]

The status of spot member to include in the result

invitationDate[before]integer

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

invitationDate[after]integer

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

registrationDate[before]integer

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

registrationDate[after]integer

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/spotMembers'

200

400

200

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "customRoleId": "text",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "role": "Member",
      "status": "Accepted",
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Spot members returned successfully