Skip to main content
PATCH
/
organizations
/
{organizationId}
Update organization details
curl --request PATCH \
  --url https://api.hixbe.com/account/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string
required

Body

application/json
name
string

Organization name

Required string length: 1 - 100
description
string

Organization description

Maximum string length: 500

Response

200 - application/json

Organization updated successfully

id
string
required

Organization unique identifier

name
string
required

Organization name

description
string

Organization description

createdAt
string<date-time>

Organization creation timestamp

updatedAt
string<date-time>

Organization last update timestamp