Skip to main content
POST
/
api
/
v1
/
invitations
Create invitations
curl --request POST \
  --url https://apix.us.amity.co/api/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "communityMemberInvite",
  "targetType": "community",
  "targetId": "68583742eae5300158b6d144",
  "userIds": [
    "B user",
    "C user"
  ]
}
'
{
  "invitations": [
    {
      "_id": "<string>",
      "networkId": "<string>",
      "targetId": "<string>",
      "userId": "<string>",
      "createdBy": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "invitationId": "<string>",
      "invitedUserId": "<string>",
      "invitedUserPublicId": "<string>",
      "invitedUserInternalId": "<string>",
      "inviterUserId": "<string>",
      "inviterUserPublicId": "<string>",
      "inviterUserInternalId": "<string>",
      "respondedAt": "2023-11-07T05:31:56Z",
      "communityId": "<string>"
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create invitation request payload

​
type
enum<string>
required

Type of invitation to create

Available options:
communityMemberInvite,
livestreamCohostInvite
Example:

"communityMemberInvite"

​
targetType
enum<string>
required

Type of target entity

Available options:
community,
room
Example:

"community"

​
targetId
string
required

ID of the target entity (community, group, etc.)

Required string length: 1 - 900
Example:

"68583742eae5300158b6d144"

​
userIds
string[]
required

Array of user IDs to invite

Required array length: 1 - 1000 elements

User ID to invite

Required string length: 1 - 50
Example:
["user123", "user456", "user789"]

Response

Create invitation response

​
invitations
object[]

Array of created invitation objects

​
users
object[]

User details for invited users