Skip to main content
PATCH
/
organizations
/
{organization_id}
Update Organization
curl --request PATCH \
  --url https://api.example.com/organizations/{organization_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>"
}
'
{
  "id": "<string>",
  "entity": "organization",
  "broker": "WORKOS",
  "broker_id": "<string>",
  "handle": "<string>",
  "name": "<string>",
  "version": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "picture": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Path Parameters

organization_id
string
required

Body

application/json
name
string
Maximum string length: 255
handle
string

Response

Organization updated

id
string
required
entity
string
default:organization
required
broker
enum<string>
required
Available options:
WORKOS
broker_id
string
required
handle
string
required
name
string
required
version
integer
default:1
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
picture
string
deleted_at
string<date-time>