PUT
/
v3
/
orgs
/
{orgId}
curl --request PUT \
  --url https://api.ctrl-hub.com/v3/orgs/{orgId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "type": "organisations",
    "id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
    "attributes": {
      "name": "Ctrl Hub",
      "description": "Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements"
    }
  }
}'
{
  "data": {
    "type": "organisations",
    "id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
    "attributes": {
      "name": "Ctrl Hub",
      "slug": "ctrl-hub",
      "description": "Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements",
      "settings": {
        "nomenclature": {
          "governance": {
            "schemes": [
              {
                "language": "en-GB",
                "singular": "Scheme",
                "plural": "Schemes"
              }
            ],
            "work_orders": [
              {
                "language": "en-GB",
                "singular": "Work Order",
                "plural": "Work Orders"
              }
            ],
            "operations": [
              {
                "language": "en-GB",
                "singular": "Operation",
                "plural": "Operations"
              }
            ]
          }
        }
      }
    },
    "meta": {
      "created_at": "2024-06-13T07:15:23.000Z",
      "status": "active"
    },
    "links": {
      "self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721"
    }
  }
}

An organisation slug is immutable and cannot be updated

Authorizations

​
Authorization
string
header
required

To understand how to authenticate, see the auth docs

Path Parameters

​
orgId
string
required

The ID of the organisation

Body

application/json
​
data
object

Response

200
application/json
​
data
object
Create an OrganisationScheme Model