Skip to content

Update an organization

PATCH
/v1/organizations/{org_uuid}

Only admin users can modify an organization.

Authorizations

jwtToken
TypeHTTP (bearer)

Parameters

Path Parameters

org_uuid*

UUID of the organization

Typestring
Required
format"uuid"

Request Body

application/json
JSON
{
"display_name": "Terramate GmbH",
"domain": "terramate.io",
"github_owner": "terramate-io",
"gitlab_owner": "terramate-io",
"slack_webhook": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
}

Responses

OK

application/json
JSON
{
"name": "terramate",
"display_name": "Terramate GmbH",
"domain": "terramate.io",
"github_owner": "terramate-io",
"gitlab_owner": "terramate-io",
"slack_webhook": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI