Disables a community: it stops issuing and renewing memberships (UC-CM-37).
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/community-memberships/communities/example/disable"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"OperationId\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Reason\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/community-memberships/communities/example/disable';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"OperationId":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Reason":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/community-memberships/communities/example/disable \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "OperationId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Reason": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Community identifier.
Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”The version read, the required reason and the operation identity.
HTTP body of a community action that changes no values: disable, enable (UC-CM-37) or delete (UC-CM-70); the route names the action. The module validates every value.
object
Client-chosen identity of this submission. A retry with the same identity and the same values returns the first result; the same identity with other values is rejected.
Version the client read; a change made by someone else in between rejects the request.
Required explanation stored in history for disabling, enabling or deleting.
Examplegenerated
{ "OperationId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Reason": "example"}HTTP body of a community action that changes no values: disable, enable (UC-CM-37) or delete (UC-CM-70); the route names the action. The module validates every value.
object
Client-chosen identity of this submission. A retry with the same identity and the same values returns the first result; the same identity with other values is rejected.
Version the client read; a change made by someone else in between rejects the request.
Required explanation stored in history for disabling, enabling or deleting.
Examplegenerated
{ "OperationId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Reason": "example"}HTTP body of a community action that changes no values: disable, enable (UC-CM-37) or delete (UC-CM-70); the route names the action. The module validates every value.
object
Client-chosen identity of this submission. A retry with the same identity and the same values returns the first result; the same identity with other values is rejected.
Version the client read; a change made by someone else in between rejects the request.
Required explanation stored in history for disabling, enabling or deleting.
Examplegenerated
{ "OperationId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Reason": "example"}Responses
Section titled “Responses”OK
object
HTTP result of a Community Memberships command that creates, changes or deletes one record.
object
Identifier of the created, changed or deleted record.
Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
HTTP result of a Community Memberships command that creates, changes or deletes one record.
object
Identifier of the created, changed or deleted record.
Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
HTTP result of a Community Memberships command that creates, changes or deletes one record.
object
Identifier of the created, changed or deleted record.
Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Not Found
object
HTTP result of a Community Memberships command that creates, changes or deletes one record.
object
Identifier of the created, changed or deleted record.
Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
HTTP result of a Community Memberships command that creates, changes or deletes one record.
object
Identifier of the created, changed or deleted record.
Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}