Update role

PUT

/v1/companies/roles/{roleId}

Updates an existing role.

This operation fully replaces the role object — there is no partial update and no prior read of individual permissions by the API. The complete desired data set (name, description, type, internal-role flag, and the full permissions list) must be resent on every update, even when only one field is changing. An incomplete payload can result in a validation error or in the loss of permissions that were not resent.

Since there is no way to retrieve a role's current permissions directly from the role listing, we recommend keeping an up-to-date copy of each role's complete payload on the integration side as the source of the desired state.

There are standard canonical roles — for example, credit analyst, credit manager, credit director, and commercial profiles — commonly used as a permissions reference when setting up roles for new companies.

The success response is 200 with an empty body.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Role updated

application/json

The role was updated successfully. The API returns 200 with an empty body.

Bodyapplication/json

🟠422Incomplete or invalid payload

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/v1/companies/roles/' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "description": "string",
    "type": "string",
    "intern": true,
    "permissions": [
        {
            "module": "string",
            "permissions": {}
        }
    ]
}'

Response Example

200 - Exemplo 1

{}

Modificado em 2026-07-28 20:38:32

Página anterior

List company roles

Próxima página

List permissions catalog