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>",
"type": "communityMemberInvite",
"targetId": "<string>",
"targetType": "community",
"userId": "<string>",
"status": "pending",
"createdBy": "<string>",
"respondedAt": "2023-11-07T05:31:56Z",
"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>",
"communityId": "<string>"
}
],
"users": [
{
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true
}
]
}
Creates new invitations for the specified users to join a target entity (community, group, or event).
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>",
"type": "communityMemberInvite",
"targetId": "<string>",
"targetType": "community",
"userId": "<string>",
"status": "pending",
"createdBy": "<string>",
"respondedAt": "2023-11-07T05:31:56Z",
"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>",
"communityId": "<string>"
}
],
"users": [
{
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true
}
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Create invitation request payload
The body is of type object
.
Create invitation response
The response is of type object
.