Skip to main content
POST
/
api
/
v1
/
social
/
invite
/
{socialId}
POST /api/v1/social/invite/{socialId}
curl --request POST \
  --url https://api.scoot.app/api/v1/social/invite/{socialId} \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "socialInviteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "socialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invitedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invitedUser": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "emailAddress": "<string>",
      "emailVerified": true,
      "preload": true,
      "mobilePhone": "<string>",
      "mobilePhoneVerified": true,
      "mobilePhoneVerifiedWeb": true,
      "profileId": "<string>",
      "profileImageURI": "<string>",
      "profileImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profileImageBackground": "<string>",
      "timeZone": "<string>",
      "registeredDateTime": "2023-11-07T05:31:56Z",
      "active": true,
      "actedAs": true
    },
    "didAttend": true,
    "dateTimeInvited": "2023-11-07T05:31:56Z",
    "error": "<string>"
  }
]'
[
  {
    "socialInviteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "socialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invitedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invitedUser": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "emailAddress": "<string>",
      "emailVerified": true,
      "preload": true,
      "mobilePhone": "<string>",
      "mobilePhoneVerified": true,
      "mobilePhoneVerifiedWeb": true,
      "profileId": "<string>",
      "profileImageURI": "<string>",
      "profileImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profileImageBackground": "<string>",
      "timeZone": "<string>",
      "registeredDateTime": "2023-11-07T05:31:56Z",
      "active": true,
      "actedAs": true
    },
    "didAttend": true,
    "dateTimeInvited": "2023-11-07T05:31:56Z",
    "error": "<string>"
  }
]
Sends invitations to specific users to join a Scootaverse session.

Path Parameters

socialId
string<uuid>
required

Body

application/json · object[]
socialInviteId
string<uuid>
socialId
string<uuid>
invitedUserId
string<uuid>
invitedUser
object
didAttend
boolean
dateTimeInvited
string<date-time>
error
string

Response

200 - application/json

OK

socialInviteId
string<uuid>
socialId
string<uuid>
invitedUserId
string<uuid>
invitedUser
object
didAttend
boolean
dateTimeInvited
string<date-time>
error
string
I