Rename organization
const url = 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rename';const options = { method: 'POST', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"name":"example","slug":"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 http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rename \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "name": "example", "slug": "example" }'Renames an organization with new name and optional slug. Requires Super Admin privileges.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Organization UUID
Request Body required
Section titled “Request Body required ”object
New name for the organization
New slug for the organization (optional, auto-generated from name if not provided)
Example generated
{ "name": "example", "slug": "example"}Responses
Section titled “ Responses ”Organization renamed successfully
object
Unique organization identifier
Organization display name
Unique URL-friendly identifier
Organization description
Organization-specific settings
object
Organization branding configuration
object
Organization status
Last activity timestamp
Primary contact name
Billing email address
Whether the organization is active (deprecated, use status)
When the organization was created
When the organization was last updated
Organization resource statistics
object
Total number of users in the organization
Number of active users in the organization
Total number of devices in the organization
Number of online or provisioned devices
Total number of deployments in the organization
Number of running deployments
Example
{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Acme Corporation", "slug": "acme-corp", "description": "Leading manufacturer of industrial automation equipment", "settings": { "timezone": "America/New_York", "locale": "en-US" }, "branding": { "primaryColor": "#003366", "logo": "https://example.com/logo.png" }, "status": "active", "lastActivityAt": "2024-06-20T14:45:00Z", "primaryContact": "John Smith", "billingEmail": "billing@acme-corp.com", "active": true, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-06-20T14:45:00Z", "stats": { "userCount": 25, "activeUsers": 20, "deviceCount": 150, "activeDevices": 120, "deploymentCount": 42, "runningDeployments": 35 }}Invalid input data
Unauthorized
Forbidden - Super Admin required
Organization not found
Slug already exists