Axuz Developers

POST /teams/{teamId}/flowcharts/{id}/shares

Cria share multi-mode (`public`/`email`/`time`).

  • Acesso: Membro da equipe
  • Serviço: https://api-flow.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— POST /teams/{tid}/flowcharts/{id}/shares. Validates mode/access enums, mode-specific fields (target_email for email, expires_at-in-future for time), then inserts. Handler thin: delegate → parseCreateShareInput → flowExists → randomShareToken → insertFlowchartShareRow.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
idpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
modestringsim

enum: "public", "email", "time"

accessstringsim

enum: "view", "interact"

target_emailstring<email>não

Obrigatório quando mode=email.

expires_atstring<date-time>não

Obrigatório quando mode=time; opcional nos demais.

max_viewsinteger | nullnão

Auto-revoga o share ao atingir esse número de views.

{
  "mode": "public",
  "access": "view",
  "target_email": "pessoa@example.test",
  "expires_at": "2026-01-15T12:00:00Z",
  "max_views": 1
}

Respostas

201

Share criado.

NomeTipoObrigatórioDescrição
idstring<uuid>sim
flowchart_idstring<uuid>sim
created_bystring<uuid>sim
modestringsim

enum: "public", "email", "time"

accessstringsim

enum: "view", "interact"

target_emailstring<email> | nullnão
expires_atstring<date-time> | nullnão
tokenstringsim
urlstringsim
revoked_atstring<date-time> | nullnão
created_atstring<date-time>sim
max_viewsinteger | nullnão
current_viewsintegersim

400

Payload inválido.

NomeTipoObrigatórioDescrição
errorstringsim

401

JWT ausente/expirado.

NomeTipoObrigatórioDescrição
errorstringsim

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NomeTipoObrigatórioDescrição
errorstringsim

404

Recurso não encontrado ou fora de escopo.

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Falha inesperada (log + trace).

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X POST 'https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID/shares' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode":"public","access":"view","target_email":"pessoa@example.test","expires_at":"2026-01-15T12:00:00Z","max_views":1}'

Node.js

const res = await fetch("https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID/shares", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "mode": "public",
    "access": "view",
    "target_email": "pessoa@example.test",
    "expires_at": "2026-01-15T12:00:00Z",
    "max_views": 1
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID/shares",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "mode": "public",
        "access": "view",
        "target_email": "pessoa@example.test",
        "expires_at": "2026-01-15T12:00:00Z",
        "max_views": 1,
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())