Adicionar usuário ao fluxo

POST

/v1/flows/{id}/users

Concede a um usuário acesso a um flow, associando-o a um cargo (role) específico dentro dele.

O payload exige o formato completo {users:[{userId, userName, userEmail, role:{id, name}}]}. Um formato simplificado, como {userId, roleId}, é rejeitado com erro 400 — a API não aceita roleId solto: o cargo deve ser informado como o objeto role:{id, name}, e userName/userEmail são obrigatórios em cada item de users, mesmo que esses dados já existam associados ao userId em outro lugar da plataforma.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Usuário adicionado

application/json

O(s) usuário(s) foram associados ao flow com sucesso.

Bodyapplication/json

🟠400Payload inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//users' \
--header 'Content-Type: application/json' \
--data '{
    "users": [
        {
            "userId": "string",
            "userName": "string",
            "userEmail": "string",
            "role": {
                "id": "string",
                "name": "string"
            }
        }
    ]
}'

Response Example

201 - Exemplo 1

{
    "users": [
        {
            "userId": "string",
            "userName": "string",
            "userEmail": "string",
            "role": {}
        }
    ]
}

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

Página anterior

Remover fluxo

Próxima página

Remover usuário do fluxo