Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Required string length:
1 - 900curl --request POST \
--url https://apix.us.amity.co/api/v4/communities/{communityId}/join \
--header 'Authorization: Bearer <token>'{
"joinRequests": [
{
"_id": "<string>",
"networkId": "<string>",
"targetId": "<string>",
"targetType": "<string>",
"type": "<string>",
"userId": "<string>",
"status": "<string>",
"respondedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"joinRequestId": "<string>",
"requestorId": "<string>",
"requestorPublicId": "<string>",
"requestorInternalId": "<string>",
"responderId": "<string>",
"responderPublicId": "<string>",
"responderInternalId": "<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
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"roles": [
{
"roleId": "<string>",
"displayName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"permissions": [
"<string>"
],
"isDeleted": false
}
]
}Creates a community membership request for the requesting user and once approved by moderators, that user will become a member of the community.
Key Features:
requiresJoinApproval to false, the user will be added to the community immediately with approved request created.requiresJoinApproval to true, the user will have pending request created, and the moderators will need to approve or decline.curl --request POST \
--url https://apix.us.amity.co/api/v4/communities/{communityId}/join \
--header 'Authorization: Bearer <token>'{
"joinRequests": [
{
"_id": "<string>",
"networkId": "<string>",
"targetId": "<string>",
"targetType": "<string>",
"type": "<string>",
"userId": "<string>",
"status": "<string>",
"respondedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"joinRequestId": "<string>",
"requestorId": "<string>",
"requestorPublicId": "<string>",
"requestorInternalId": "<string>",
"responderId": "<string>",
"responderPublicId": "<string>",
"responderInternalId": "<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
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"roles": [
{
"roleId": "<string>",
"displayName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"permissions": [
"<string>"
],
"isDeleted": false
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
1 - 900