Ver .md

members.update

Altera papel ou permissões de um membro. Não permite rebaixar o último administrador da conta.

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

Entrada

CampoTipoObrigatórioNota
userIdstringsim
role"admin" | "user"não
permissionsobjectnão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "userId": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "user"
      ]
    },
    "permissions": {
      "type": "object",
      "properties": {
        "modules": {
          "anyOf": [
            {
              "type": "string",
              "const": "*"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "screens": {
          "anyOf": [
            {
              "type": "string",
              "const": "*"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "channels": {
          "anyOf": [
            {
              "type": "string",
              "const": "*"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        }
      },
      "required": [
        "modules",
        "screens",
        "channels"
      ]
    }
  },
  "required": [
    "userId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs members.update --json '{"userId":"00000000-0000-0000-0000-000000000000","role":"user"}'

MCP: ferramenta members_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": {
    "userId": {
      "type": "string"
    }
  },
  "required": [
    "userId"
  ],
  "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).