Invite a spot member

POST /v1/spotMembers

application/json

Body Required

email string Required

The email of the spot member
withEmailNotification boolean

Set to true to send notification mail to each invited members

Default value is false.

Responses

201 application/json

Spot member has been successfully invited
Hide response attributes Show response attributes object
- id string Required
  
  The id of the spot member.
- spotId string Required
  
  The id of the spot.
- userId string | null Required
  
  The id of the user.
- email string Required
  
  The email of the spot member.
- title string | null Required
  
  The title of the spot member.
- lang string Required
  
  The lang of the spot member.
  
  Values are en, fr, de, it, es, pt, or nl.
- role string Required
  
  The role of the spot member.
  
  Values are Member or Admin.
- customRoleId string | null Required
  
  The custom role ID of the spot member.
- status string Required
  
  The status of the spot member.
  
  Values are Accepted, Deactivated, DeclinedInvitation, Invited, Left, Pending, or Rejected.
- firstname string Required
  
  The firstname of the spot member.
- lastname string Required
  
  The lastname of the spot member.
- warnings number Required
  
  The number of warnings the spot member has.
- embedBaseUrls object Required
  
  The custom embed base URLs of the spot member.
  
  Hide embedBaseUrls attributes Show embedBaseUrls attributes object
  
  default string
  
  * string Additional properties
- updatedAt integer | null Required
  
  Timestamp in ms of updated date
400

Malformed payload

POST /v1/spotMembers

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

Request examples

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

Response examples (201)

{
  "id": "string",
  "spotId": "string",
  "userId": "string",
  "email": "string",
  "title": "string",
  "lang": "en",
  "role": "Member",
  "customRoleId": "string",
  "status": "Accepted",
  "firstname": "string",
  "lastname": "string",
  "warnings": 42.0,
  "embedBaseUrls": {
    "default": "string",
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "updatedAt": 42
}