PATCH https://api.sonorancms.com/v2/community/sessions
Rate limit: 27 requests per minute
Authenticated v2 endpoints are rate limited per credential rather than per IP address.Stop an active session.
Request Body
| Name | Type | Required | Description | | --- | --- | --- | --- | |serverId | number | Yes | See example request for the shape. |
| accId | string | Yes | See example request for the shape. |
Example Request
- Sonoran.lua
- Sonoran.js
- Sonoran.py
- Sonoran.Net
- OpenAPI
- cURL
local Sonoran = require("sonoran")
local sonoran = Sonoran.createClient({
product = Sonoran.productEnums.CMS,
apiKey = "YOUR_API_KEY",
communityId = "YOUR_COMMUNITY_ID",
defaultServerId = 1,
timeoutMs = 30000,
})
local payload = {
["serverId"] = 1,
["accId"] = "00000000-0000-0000-0000-000000000000"
}
local response = sonoran.cms:stopSessionV2(payload)
if response.success then
print(response.data)
else
print(response.reason)
end
const Sonoran = require("sonoran.js");
const instance = Sonoran.instance({
apiKey: "YOUR_API_KEY",
communityId: "YOUR_COMMUNITY_ID",
product: Sonoran.productEnums.CMS,
serverId: 1,
});
async function main() {
const payload = {
"serverId": 1,
"accId": "00000000-0000-0000-0000-000000000000"
};
const response = await instance.cms.stopSessionV2(payload);
if (response.success) {
console.log(response.data);
} else {
console.error(response.reason);
}
}
main().catch((error) => {
console.error(error);
});
from sonoran import Instance, productEnums
instance = Instance(
apiKey="YOUR_API_KEY",
communityId="YOUR_COMMUNITY_ID",
product=productEnums.CMS,
serverId=1,
)
payload = {
"serverId": 1,
"accId": "00000000-0000-0000-0000-000000000000"
}
response = instance.cms.stopSessionV2(payload)
if response.success:
print(response.data)
else:
print(response.reason)
using Sonoran;
using System.Text.Json;
using var sonoran = new SonoranClient(new SonoranClientOptions
{
product = SonoranProduct.CMS,
apiKey = "YOUR_API_KEY",
communityId = "YOUR_COMMUNITY_ID",
defaultServerId = 1
});
var payload = new {
serverId = 1,
accId = "00000000-0000-0000-0000-000000000000"
};
var response = await sonoran.Cms.stopSessionV2(payload);
if (response.success)
{
Console.WriteLine(JsonSerializer.Serialize(response.data));
}
else
{
Console.WriteLine(response.reason);
}
openapi: "3.0.3"
info:
title: "Sonoran CMS v2 - Stop Session"
version: "1.0.0"
description: "Stop an active session."
servers:
-
url: "https://api.sonorancms.com"
paths:
/v2/community/sessions:
patch:
summary: "Stop Session"
operationId: "stopSession"
requestBody:
required: true
content:
application/json:
schema:
type: "object"
security:
-
bearerAuth: []
responses:
"200":
description: "Successful response"
content:
application/json:
schema:
type: "object"
example:
success: true
data:
id: "55555555-5555-5555-5555-555555555555"
sysStatus: true
community: "00000000-0000-0000-0000-000000000000"
serverId: 1
startedBy: "00000000-0000-0000-0000-000000000000"
startedAt: "2026-04-15T00:00:00.000Z"
endedBy: null
endedAt: null
cancelledBy: null
stats: {}
metadata: {}
meta:
timestamp: "2026-04-15T00:00:00.000Z"
path: "/v2/community/sessions"
components:
securitySchemes:
bearerAuth:
type: "http"
scheme: "bearer"
bearerFormat: "JWT"
curl --request PATCH \
--url "https://api.sonorancms.com/v2/community/sessions" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json" \
--data '{"serverId":1,"accId":"00000000-0000-0000-0000-000000000000"}'
Response
Thedata object is the session row. GET, POST, and PATCH all return the CommunityServerSession entity shape on success.
{
"success": true,
"data": {
"id": "55555555-5555-5555-5555-555555555555",
"sysStatus": true,
"community": "00000000-0000-0000-0000-000000000000",
"serverId": 1,
"startedBy": "00000000-0000-0000-0000-000000000000",
"startedAt": "2026-04-15T00:00:00.000Z",
"endedBy": null,
"endedAt": null,
"cancelledBy": null,
"stats": {},
"metadata": {}
},
"meta": {
"timestamp": "2026-04-15T00:00:00.000Z",
"path": "/v2/community/sessions"
}
}

