members.invite

Convida alguém por link. Cria um convite válido por 7 dias, envia o link por e-mail e devolve o link (para copiar se o e-mail não chegar). Conta membros mais convites pendentes contra o limite de usuários do plano.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "user"
      ]
    },
    "permissions": {
      "default": {
        "modules": "*",
        "screens": "*",
        "channels": "*"
      },
      "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": [
    "email",
    "role"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/members.invite \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","role":"user","permissions":{"modules":["messages"],"screens":"*","channels":"*"}}'

CLI:

node cli/atomiks.mjs members.invite --json '{"email":"[email protected]","role":"user","permissions":{"modules":["messages"],"screens":"*","channels":"*"}}'

MCP: ferramenta members_invite com a mesma entrada.

Saída

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

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