Modifies a orgs's details

  • Published on Jul 21, 2025
  • 1 minute(s) read
Prev Next
Put
/api/v1/orgs/{orgId}
Security
HTTP
Type bearer
Path parameters
orgId
stringRequired

The ID of the org to modify

Body parameters

The org details to modify

object
description
string
name
string
Responses
201

Created

Expand All
object
authorization
boolean
data
object (Org)
description
string
fState
string
level
integer
name
string
objectGUID
string
parentOrgName
string
parentOrgObjectGUID
string
timezone
string
whenChanged
string
whenCreated
string
error_code
integer
error_message
string
error_status
boolean
Examplefalse
400

Bad Request

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean
401

Unauthorized

object
error_code
integer
error_message
string
error_status
boolean
403

Forbidden - Org already exists

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean
404

Not Found

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean
500

Internal Server Error

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean