POST api/v2.0/Communities/JoinCommunity?communityKey={communityKey}
Joins the current user to the Community identified by the specified Community Key.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| communityKey |
Unique Identifier of a Community. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Data representation of the Joined Community, if the request is successful. Returns
Community| Name | Description | Type | Additional information |
|---|---|---|---|
| AllowMemberCreatedEvents | boolean |
None. |
|
| AllowTickets | boolean |
None. |
|
| CanMembersInviteOthers | boolean |
None. |
|
| CommunityKey | globally unique identifier |
None. |
|
| LegacyGroupKey |
Unique Identifier for this Community in the source system. |
string |
None. |
| CommunityName | string |
None. |
|
| CommunitySize | integer |
None. |
|
| CommunityType | string |
None. |
|
| CommunityTypeKey | globally unique identifier |
None. |
|
| CommunityTypeName | string |
None. |
|
| CreatedByContactKey | globally unique identifier |
None. |
|
| CreatedOn | date |
None. |
|
| Description | string |
None. |
|
| Html | string |
None. |
|
| IsSubscribedToDiscussion | boolean |
None. |
|
| IsOnCommunitySync | boolean |
None. |
|
| JoinPermissionKey | globally unique identifier |
None. |
|
| LibraryKey | globally unique identifier |
None. |
|
| LibraryName | string |
None. |
|
| LinkToCommunity | string |
None. |
|
| LinkToCommunityCalendar | string |
None. |
|
| LinkToDiscussion | string |
None. |
|
| LinkToLibrary | string |
None. |
|
| LinkToWebsite | string |
None. |
|
| DiscussionKey | globally unique identifier |
None. |
|
| DiscussionName | string |
None. |
|
| MicrositeGroupKey | globally unique identifier |
None. |
|
| SiteName | string |
None. |
|
| ViewPermissionKey | globally unique identifier |
None. |
|
| Statistics | CommunityStatistics |
None. |
|
| CreatedByContact | ContactConcise |
None. |
|
| IntegrationKey |
Community Key as represented in the source data. |
string |
None. |
| IntegrationTypeKey |
Community Type Key as represented in the source data. |
string |
None. |
| ParentCommunityKey | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"AllowMemberCreatedEvents": true,
"AllowTickets": true,
"CanMembersInviteOthers": true,
"CommunityKey": "48bcd3d5-e86b-440d-8352-ecf4790731f4",
"LegacyGroupKey": "sample string 5",
"CommunityName": "sample string 6",
"CommunitySize": 7,
"CommunityType": "sample string 8",
"CommunityTypeKey": "74a3d179-ca15-4150-be50-3ce30e95537f",
"CommunityTypeName": "sample string 10",
"CreatedByContactKey": "09ba7693-77f3-4cbc-b3a3-008a1f23a28e",
"CreatedOn": "2021-01-15T14:50:33.2663952Z",
"Description": "sample string 13",
"Html": "sample string 14",
"IsSubscribedToDiscussion": true,
"IsOnCommunitySync": true,
"JoinPermissionKey": "ba64d59d-f9cd-49ca-bd2e-86e4e9036531",
"LibraryKey": "9555b758-7db5-4a1e-8685-fbd317ed9c19",
"LibraryName": "sample string 19",
"LinkToCommunity": "sample string 20",
"LinkToCommunityCalendar": "sample string 21",
"LinkToDiscussion": "sample string 22",
"LinkToLibrary": "sample string 23",
"LinkToWebsite": "sample string 24",
"DiscussionKey": "dff25db3-06e3-4b98-b7a3-08226645b742",
"DiscussionName": "sample string 26",
"MicrositeGroupKey": "e308fc63-726a-42ae-8c97-6dbdc5485f96",
"SiteName": "sample string 28",
"ViewPermissionKey": "5c1dc8b8-87fc-4065-b9ca-57b7e9cb1b4f",
"Statistics": {
"BlogCount": 1,
"DocumentCount": 2,
"MemberCount": 3,
"DiscussionPostCount": 4,
"CurrentYearAnnouncementCount": 5,
"CurrentYearEventCount": 6,
"LastDocumentUpdatedDate": "2021-01-15T14:50:33.2663952Z",
"LastMemberJoinedDate": "2021-01-15T14:50:33.2663952Z",
"LastPostingDate": "2021-01-15T14:50:33.2663952Z",
"LastBlogPublishedDate": "2021-01-15T14:50:33.2663952Z",
"LastAnnouncementUpdatedOnDate": "2021-01-15T14:50:33.2663952Z",
"LastEventUpdatedOnDate": "2021-01-15T14:50:33.2663952Z",
"MaxActivityDate": "2021-01-15T14:50:33.2663952Z",
"MinActivityDate": "2021-01-15T14:50:33.2663952Z"
},
"CreatedByContact": {
"LinkToProfile": "sample string 1",
"PictureUrl": "sample string 2",
"ContactKey": "e313c14d-4896-45dc-a5a6-ef567c16ef2b",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"DisplayName": "sample string 6",
"EmailAddress": "sample string 7",
"ContactStatusCode": "sample string 8",
"PrefixCode": "sample string 9",
"UpdatedOn": "2021-01-15T14:50:33.2663952Z",
"UpdatedByContactKey": "c068c3e0-7c41-45cc-89ac-a76fb83f545d",
"CompanyName": "sample string 12",
"CompanyTitle": "sample string 13",
"SuffixCode": "sample string 14",
"Designation": "sample string 15",
"LegacyContactKey": "sample string 16",
"InformalName": "sample string 17",
"MiddleName": "sample string 18",
"IsCompany": true,
"CompanyLegacyContactKey": "sample string 20",
"AMSDirectoryOptOut": true,
"HLDirectoryOptOut": true,
"HLContactMeOptOut": true,
"LargePictureUrl": "sample string 24",
"AgreedToTermsDateTime": "2021-01-15T14:50:33.2663952Z"
},
"IntegrationKey": "sample string 30",
"IntegrationTypeKey": "sample string 31",
"ParentCommunityKey": "4b9a83a3-9ea6-4e27-8187-081b43a4b77b"
}
application/xml, text/xml
Sample:
<Community xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
<AllowMemberCreatedEvents>true</AllowMemberCreatedEvents>
<AllowTickets>true</AllowTickets>
<CanMembersInviteOthers>true</CanMembersInviteOthers>
<CommunityKey>48bcd3d5-e86b-440d-8352-ecf4790731f4</CommunityKey>
<CommunityName>sample string 6</CommunityName>
<CommunitySize>7</CommunitySize>
<CommunityType>sample string 8</CommunityType>
<CommunityTypeKey>74a3d179-ca15-4150-be50-3ce30e95537f</CommunityTypeKey>
<CommunityTypeName>sample string 10</CommunityTypeName>
<CreatedByContact>
<AMSDirectoryOptOut>true</AMSDirectoryOptOut>
<AgreedToTermsDateTime>2021-01-15T09:50:33.2663952-05:00</AgreedToTermsDateTime>
<CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
<CompanyName>sample string 12</CompanyName>
<CompanyTitle>sample string 13</CompanyTitle>
<ContactKey>e313c14d-4896-45dc-a5a6-ef567c16ef2b</ContactKey>
<ContactStatusCode>sample string 8</ContactStatusCode>
<Designation>sample string 15</Designation>
<DisplayName>sample string 6</DisplayName>
<EmailAddress>sample string 7</EmailAddress>
<FirstName>sample string 4</FirstName>
<HLContactMeOptOut>true</HLContactMeOptOut>
<HLDirectoryOptOut>true</HLDirectoryOptOut>
<InformalName>sample string 17</InformalName>
<IsCompany>true</IsCompany>
<LargePictureUrl>sample string 24</LargePictureUrl>
<LastName>sample string 5</LastName>
<LegacyContactKey>sample string 16</LegacyContactKey>
<LinkToProfile>sample string 1</LinkToProfile>
<MiddleName>sample string 18</MiddleName>
<PictureUrl>sample string 2</PictureUrl>
<PrefixCode>sample string 9</PrefixCode>
<SuffixCode>sample string 14</SuffixCode>
<UpdatedByContactKey>c068c3e0-7c41-45cc-89ac-a76fb83f545d</UpdatedByContactKey>
<UpdatedOn>2021-01-15T09:50:33.2663952-05:00</UpdatedOn>
</CreatedByContact>
<CreatedByContactKey>09ba7693-77f3-4cbc-b3a3-008a1f23a28e</CreatedByContactKey>
<CreatedOn>2021-01-15T09:50:33.2663952-05:00</CreatedOn>
<Description>sample string 13</Description>
<DiscussionKey>dff25db3-06e3-4b98-b7a3-08226645b742</DiscussionKey>
<DiscussionName>sample string 26</DiscussionName>
<Html>sample string 14</Html>
<IntegrationKey>sample string 30</IntegrationKey>
<IntegrationTypeKey>sample string 31</IntegrationTypeKey>
<IsOnCommunitySync>true</IsOnCommunitySync>
<IsSubscribedToDiscussion>true</IsSubscribedToDiscussion>
<JoinPermissionKey>ba64d59d-f9cd-49ca-bd2e-86e4e9036531</JoinPermissionKey>
<LegacyGroupKey>sample string 5</LegacyGroupKey>
<LibraryKey>9555b758-7db5-4a1e-8685-fbd317ed9c19</LibraryKey>
<LibraryName>sample string 19</LibraryName>
<LinkToCommunity>sample string 20</LinkToCommunity>
<LinkToCommunityCalendar>sample string 21</LinkToCommunityCalendar>
<LinkToDiscussion>sample string 22</LinkToDiscussion>
<LinkToLibrary>sample string 23</LinkToLibrary>
<LinkToWebsite>sample string 24</LinkToWebsite>
<MicrositeGroupKey>e308fc63-726a-42ae-8c97-6dbdc5485f96</MicrositeGroupKey>
<SiteName>sample string 28</SiteName>
<Statistics>
<BlogCount>1</BlogCount>
<CurrentYearAnnouncementCount>5</CurrentYearAnnouncementCount>
<CurrentYearEventCount>6</CurrentYearEventCount>
<DiscussionPostCount>4</DiscussionPostCount>
<DocumentCount>2</DocumentCount>
<LastAnnouncementUpdatedOnDate>2021-01-15T09:50:33.2663952-05:00</LastAnnouncementUpdatedOnDate>
<LastBlogPublishedDate>2021-01-15T09:50:33.2663952-05:00</LastBlogPublishedDate>
<LastDocumentUpdatedDate>2021-01-15T09:50:33.2663952-05:00</LastDocumentUpdatedDate>
<LastEventUpdatedOnDate>2021-01-15T09:50:33.2663952-05:00</LastEventUpdatedOnDate>
<LastMemberJoinedDate>2021-01-15T09:50:33.2663952-05:00</LastMemberJoinedDate>
<LastPostingDate>2021-01-15T09:50:33.2663952-05:00</LastPostingDate>
<MaxActivityDate>2021-01-15T09:50:33.2663952-05:00</MaxActivityDate>
<MemberCount>3</MemberCount>
<MinActivityDate>2021-01-15T09:50:33.2663952-05:00</MinActivityDate>
</Statistics>
<ViewPermissionKey>5c1dc8b8-87fc-4065-b9ca-57b7e9cb1b4f</ViewPermissionKey>
</Community>