Jump to

• Request
• Response

Update Organization

put

/v1/uwaas/orgs/{orgId}

Update an organization by ID.

Request

Path Parameters

• orgId(required): string
  External organization identifier.

  Example:

  org-founder-bank

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• description(required): string
  Example: This is a company.
• organizationName(required): string
  Example: Schimmel Inc
• orgId(required): string
  Example: org-d304441f-9b69-420c-b0af-dc77e3bff16b
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Organization lifecycle status shown in Org Management.

  Example: ACTIVE
• tags: array tags
  Optional tags to assign to the organization. Tags are normalized before persistence.

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string",
            "example":"org-d304441f-9b69-420c-b0af-dc77e3bff16b"
        },
        "organizationName":{
            "type":"string",
            "example":"Schimmel Inc"
        },
        "description":{
            "type":"string",
            "example":"This is a company."
        },
        "tags":{
            "type":"array",
            "description":"Optional tags to assign to the organization. Tags are normalized before persistence.",
            "items":{
                "type":"string",
                "maxLength":255
            },
            "example":[
                "tier:gold"
            ]
        },
        "status":{
            "$ref":"#/components/schemas/OrganizationStatus"
        }
    },
    "required":[
        "orgId",
        "organizationName",
        "description",
        "status"
    ]
}

Nested Schema : tags

Type: array

Optional tags to assign to the organization. Tags are normalized before persistence.

Show Source

• Array of: string
  Maximum Length: 255

{
    "type":"array",
    "description":"Optional tags to assign to the organization. Tags are normalized before persistence.",
    "items":{
        "type":"string",
        "maxLength":255
    },
    "example":[
        "tier:gold"
    ]
}

Example:

[
    "tier:gold"
]

Examples

Select an example updateOrg

Back to Top

Response

Supported Media Types

• application/json

200 Response

Organization updated successfully.

Body ()

Root Schema : OrganizationResponse

Type: object

Show Source

• createdAt(required): string (date-time)
  Read Only: true
• createdBy(required): string
  Read Only: true

  Example: 08819d29-de56-48ea-a140-bc4ac73952ed
• description(required): string
  Example: This is a company.
• isDeleted(required): boolean
  Example: false
• organizationName(required): string
  Example: Organization A
• orgId(required): string
  Example: org-99762dae-9962-4523-ad30-d2b51fd3b06c
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Organization lifecycle status shown in Org Management.

  Example: ACTIVE
• tags: array tags
• updatedAt(required): string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true

  Example: 08819d29-de56-48ea-a140-bc4ac73952ed

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string",
            "example":"org-99762dae-9962-4523-ad30-d2b51fd3b06c"
        },
        "organizationName":{
            "type":"string",
            "example":"Organization A"
        },
        "description":{
            "type":"string",
            "example":"This is a company."
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "jurisdiction:emea",
                "jurisdiction:eu"
            ]
        },
        "status":{
            "$ref":"#/components/schemas/OrganizationStatus"
        },
        "isDeleted":{
            "type":"boolean",
            "example":false
        },
        "createdAt":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "example":"08819d29-de56-48ea-a140-bc4ac73952ed"
        },
        "updatedAt":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "example":"08819d29-de56-48ea-a140-bc4ac73952ed"
        }
    },
    "required":[
        "orgId",
        "organizationName",
        "description",
        "status",
        "isDeleted",
        "createdAt",
        "createdBy",
        "updatedAt"
    ]
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "jurisdiction:emea",
        "jurisdiction:eu"
    ]
}

Example:

[
    "jurisdiction:emea",
    "jurisdiction:eu"
]

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

409 Response

Organization name already exists.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top