roles.update

Renomeia um cargo ou muda as telas dele. Cargos fixos não mudam (forbidden). Mudar as telas regrava o acesso de quem tem o cargo.

• Endpoint: POST https://app.atomiks.com.br/api/v1/roles.update (corpo JSON)
• Quem pode chamar: administrador da conta
• Escopo da chave: team:write
• Grava dados: sim
• Pela chave de API: sim
• Ferramenta MCP: roles_update
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId roles.update)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "screens": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/roles.update \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","name":"Atendimento"}'

CLI:

node cli/atomiks.mjs roles.update --json '{"id":"00000000-0000-0000-0000-000000000000","name":"Atendimento"}'

MCP: ferramenta roles_update com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "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).