Skip to main content
PUT
/
api
/
v1
/
orgs
/
{org_id}
Update Org
curl --request PUT \
  --url https://api.example.com/api/v1/orgs/{org_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Updated Project",
  "description": "The project now aims to...",
  "status": "completed",
  "metadata": {
    "priority": "medium",
    "team_size": 7
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
org_id
string
required

Body

application/json
​
name
string | null

Updated name of the project

Example:

"My Updated Project"

​
description
string | null

Updated description of the project

Example:

"The project now aims to..."

​
status
string | null

Updated status of the project

Example:

"completed"

​
metadata
Metadata · object

Updated project metadata in key-value pairs

Example:
{ "priority": "medium", "team_size": 7 }

Response

Successful Response