Skip to main content
Update an organization
curl --request PATCH \
  --url https://api.ionworks.com/organizations/{organization_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "usage_limit": {},
  "nav_config": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "usage_limit": {},
  "nav_config": {},
  "user_organization_roles": [
    {
      "organization_id": "<string>",
      "user_id": "<string>",
      "users": {
        "id": "<string>",
        "email": "<string>"
      },
      "organization_role_id": "<string>",
      "organization_roles": {
        "name": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "organization_role_permissions": [
          {}
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
organization_id
string
required

Body

application/json

Model for updating an existing organization. All fields are optional.

​
name
string | null

New name of the organization

​
usage_limit

Monthly usage limit

​
nav_config
Nav Config · object

Per-organization nav config: { '': { 'show': bool, 'disabled': bool, 'badgeLabel': str | None, 'badgeTooltip': str | None } }

Response

Successful Response

Pydantic model for an organization.

​
id
string
required
​
name
string
required
​
slug
string
required
​
usage_limit

Monthly usage limit

​
nav_config
Nav Config · object

Per-organization nav config: { '': { 'show': bool, 'disabled': bool, 'badgeLabel': str | None, 'badgeTooltip': str | None } }

​
user_organization_roles
UserOrganizationRole · object[] | null

List of user organization roles

​
created_at
string<date-time> | null

Timestamp of creation

​
updated_at
string<date-time> | null

Timestamp of last update