🗃️Endpoints - Spot Members

Invite a Spot member

post

Invite a spot member

Corps

emailstringRequis

The email of the spot member

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Default: false

Réponses

201

Spot member has been successfully invited

application/json

400

Malformed payload

post

HTTPcURLJavaScriptPython

POST /v1/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "email": "text",
  "withEmailNotification": false
}

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

Invite multiple Spot members

post

Invite multiple spot members

Corps

emailsstring[] · min: 1 · max: 200Optionnel

The emails of members to invite

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Default: false

Réponses

201

Spot members has been successfully invited

application/json

400

Malformed payload

413

Payload is too large

post

HTTPcURLJavaScriptPython

POST /v1/spotMembers~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "emails": [
    "text"
  ],
  "withEmailNotification": false
}

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

Get custom form answers for a Spot member

get

Get custom form answers for 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

questionLabel[contains]stringOptionnel

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

Réponses

200

Custom form answers returned successfully

application/json

404

Custom form answers not found

get

HTTPcURLJavaScriptPython

GET /v1/spotMembers/{spotMemberId}/customFormAnswers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

Update a Spot member

put

Update a spot member

Paramètres de chemin

spotMemberIdstringRequis

The id of the spotMember

Corps

firstnamestringOptionnel

The first name of the spot member

lastnamestringOptionnel

The last name of the spot member

titlestringOptionnel

The title of the spot member

rolestring · enumOptionnel

The role of the spot member

Valeurs possibles:

statusstring · enumOptionnel

The status of the spot member

Valeurs possibles:

avatarUrlobject | nullableOptionnel

customRoleIdstring | nullableOptionnel

The custom role ID of spot member

Réponses

200

Spot member successfully updated

application/json

400

Malformed payload

404

Spot member not found

put

HTTPcURLJavaScriptPython

PUT /v1/spotMembers/{spotMemberId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "firstname": "text",
  "lastname": "text",
  "title": "text",
  "role": "Member",
  "status": "Accepted",
  "avatarUrl": {},
  "embedBaseUrls": {
    "default": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "customRoleId": "text"
}

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

Get a Spot member

get

Get a spot member

Paramètres de chemin

spotMemberIdstringRequis

The id of the spotMember

Réponses

200

Spot member returned successfully

application/json

404

Spot member not found

get

HTTPcURLJavaScriptPython

GET /v1/spotMembers/{spotMemberId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

List Spot members

get

List Spot members

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

email[in]string[]Optionnel

The emails of spot member to include in the result

firstname[in]string[]Optionnel

The firstnames of spot member to include in the result

lastname[in]string[]Optionnel

The lastnames of spot member to include in the result

customRoleId[eq]stringOptionnel

The custom role ID of Spot member

invitationDate[before]integerOptionnel

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

invitationDate[after]integerOptionnel

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

registrationDate[before]integerOptionnel

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

registrationDate[after]integerOptionnel

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

Réponses

200

Spot members returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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