Skip to main content
PUT
/
organization
/
{organizationId}
Edit an organization
curl --request PUT \
  --url https://api.qovery.com/organization/{organizationId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "website_url": "<string>",
  "repository": "<string>",
  "logo_url": "<string>",
  "icon_url": "<string>",
  "admin_emails": [
    "<string>"
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "plan": "FREE",
  "website_url": "<string>",
  "repository": "<string>",
  "logo_url": "<string>",
  "icon_url": "<string>",
  "admin_emails": [
    "<string>"
  ],
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_plan": {
    "plan": "FREE",
    "audit_logs_retention_in_days": 123
  }
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

​
organizationId
string<uuid>
required

Organization ID

Body

application/json
​
name
string
required

name is case insensitive

​
description
string
​
website_url
string | null
​
repository
string | null
​
logo_url
string | null
​
icon_url
string | null
​
admin_emails
string[] | null

Response

Edit an organization

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
name
string
required

name is case insensitive

​
plan
enum<string>
required

BUSINESS & PROFESSIONAL are deprecated

Available options:
FREE,
TEAM,
TEAM_YEARLY,
ENTERPRISE,
ENTERPRISE_YEARLY,
PROFESSIONAL,
BUSINESS
​
updated_at
string<date-time>
​
description
string | null
​
website_url
string | null
​
repository
string | null
​
logo_url
string | null
​
icon_url
string | null
​
admin_emails
string[] | null
​
owner
string<uuid>

uuid of the user owning the organization

​
organization_plan
object