roles.set_members
Define quem tem um cargo. Troca a lista de pessoas do cargo (só membros com papel user; administradores têm acesso total). Quem entra ou sai recebe o acesso novo no próximo carregamento.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/roles.set_members(corpo JSON) - Quem pode chamar: administrador da conta
- Escopo da chave:
team:write - Grava dados: sim
- Pela chave de API: sim
- Ferramenta MCP:
roles_set_members - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdroles.set_members)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
id | string | sim | |
userIds | string[] | sim |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"userIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"userIds"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/roles.set_members \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"id":"00000000-0000-0000-0000-000000000000","userIds":[]}'CLI:
node cli/atomiks.mjs roles.set_members --json '{"id":"00000000-0000-0000-0000-000000000000","userIds":[]}'MCP: ferramenta roles_set_members com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"required": [
"count"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).