Add user to flow

POST

/v1/flows/{id}/users

Grants a user access to a flow, associating them with a specific role within it.

The payload requires the full shape {users:[{userId, userName, userEmail, role:{id, name}}]}. A simplified shape, such as {userId, roleId}, is rejected with a 400 error — the API does not accept a bare roleId: the role must be provided as the object role:{id, name}, and userName/userEmail are required in every item of users, even if that data already exists elsewhere in the platform for the same userId.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201User added

application/json

The user(s) were successfully associated with the flow.

Bodyapplication/json

🟠400Invalid payload

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

Delete flow

Próxima página

Remove user from flow