Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Company Profile
Public API

Update company display name

Updates the company display name. Requires admin permissions and the company:details.write OAuth scope. The display name must be a non-empty string with a maximum length of 255 characters. Upon successful update, the system logs the change and broadcasts an event to notify other services.

OAuth Scopes: company:details.write

put/api/v1/company-profile-data/display-name

Request body

companyNamestring required

The new display name for the company. Must be a non-empty string with a maximum length of 255 characters (character count, not bytes, so multibyte UTF-8 characters are properly supported).

Example request

{
  "companyName": "Acme Corporation"
}

Response

Company name updated successfully

successboolean

Indicates whether the operation was successful

Example response

{
  "success": true
}