Update an organization

PUT 
/api/web/v1/organizations/:id

Update the specified organization. Caller requires the ORGANIZATIONS:EDIT permission.

Request

Path Parameters

id stringrequired

The UUID of the organization to be modified.

application/json

Body

required

description string

The description of the organization.

displayName string

The display name of the organization. This value must be provided when creating an organization.

logoUri string

The URI of the logo to display when showing organizations.

name string

The name of the organization. This value must be provided when creating an organization.

Responses

200

Successful

application/json

Schema

Schema

description string

The description of the organization.

displayName stringrequired

The display name of the organization.

id stringrequired

The unique UUID assigned to the organization when it is created.

logoUri string

The URI of the logo to display when showing organizations.

name stringrequired

The name of the organization.

Example (from schema)

{
  "description": "string",
  "displayName": "string",
  "id": "string",
  "logoUri": "https://account.mycompany.com/images/logo.png",
  "name": "string"
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...