/
[PATCH] /{id}

[PATCH] /{id}

/api/bpm/organizations/{id}

Description

This endpoint is used to update an organization whose id is provided in the path.

It allows updating the organization's name or setting the organization as active. At least one of the parameters, name or active, must be provided.

When an organization is successfully updated, the endpoint will return 204 No Content.

The organization name can only be updated in enaio versions greater than 12.0. The active status can be updated in all versions.

Required Systemrole

R_WFEDIT_START (ID = 21)

Request
Method

PATCH

Response
Format

JSON

Minimum Version

1.4.0

Request
Example

/api/bpm/organizations/0947CC57A9C24B3E8D1DC27BAE777CBE

{ "name": "Organisation", "active": true }

Response codes

  • 204 - Success: The organization has been successfully updated.

  • 400 - If the organizationId format is invalid or both parameters are missing.

  • 404 - If the organizationId doesn’t exist.

  • 403 - If the user does not have the required role.