For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set User Display Name

Update a stored user display name for a specific Sonoran Radio server.

Set User Display Name

PATCH /v2/servers/:communityId/users/display-name

Rate limit: 12 requests per minute This endpoint has a small internal gateway buffer, but the published public limit is 12 requests per minute.

Updates a single member display name and propagates that update to connected sessions.

Headers

Name
Value

Authorization

Bearer <community-api-key>

Content-Type

application/json

Examples

local response = client.radio:setUserDisplayNameV2({
  communityId = "YOUR_COMMUNITY_ID",
  accId = "91de0ce8-c571-11e9-9714-5600023b2434",
  displayName = "Chief Miller"
})
const response = await instance.radio?.setUserDisplayNameV2({
  communityId: "YOUR_COMMUNITY_ID",
  accId: "91de0ce8-c571-11e9-9714-5600023b2434",
  displayName: "Chief Miller"
});
response = instance.radio.setUserDisplayNameV2({
    "communityId": "YOUR_COMMUNITY_ID",
    "accId": "91de0ce8-c571-11e9-9714-5600023b2434",
    "displayName": "Chief Miller",
})
var response = await sonoran.Radio.setUserDisplayNameV2(new SetUserDisplayNameV2Request
{
    AccId = "91de0ce8-c571-11e9-9714-5600023b2434",
    DisplayName = "Chief Miller"
});
openapi: 3.1.0
paths:
  /v2/servers/{communityId}/users/display-name:
    patch:
      security:
        - bearerAuth: []

Response

Successful requests return application/json.

{
  "accId": "91de0ce8-c571-11e9-9714-5600023b2434",
  "displayName": "Officer Smith"
}

Last updated

Was this helpful?