Axuz Developers

POST /teams/{teamId}/forms/

Cria form novo (status=draft)

  • Acesso: Membro da equipe
  • Serviço: https://api-forms.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`.

slug opcional → nanoid(10). Regex slug: ^[a-zA-Z0-9_-]{3,64}$. layout normalizado via ResolveLayout.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
namestringsim
slugstringnão

Opcional; default = nanoid(10). Regex ^[a-zA-Z0-9_-]{3,64}$.

descriptionstringnão
schemaFormsFormSchemanão
schema.fieldsarray<FormsField>sim
schema.fields[].idstringsim
schema.fields[].typestringsim

enum: "text", "email", "phone", "textarea", "number", "select", "radio", "checkbox", "date", "url", "file", "hidden"

schema.fields[].labelstringnão
schema.fields[].namestringsim
schema.fields[].requiredbooleannão
schema.fields[].placeholderstringnão
schema.fields[].help_textstringnão
schema.fields[].defaultanynão
schema.fields[].optionsarray<FormsFieldOption>não
schema.fields[].options[].valuestringsim
schema.fields[].options[].labelstringsim
schema.fields[].max_lengthinteger | nullnão
schema.fields[].minnumber | nullnão
schema.fields[].maxnumber | nullnão
schema.fields[].rowsinteger | nullnão
schema.fields[].patternstringnão
schema.fields[].extraobjectnão
schema.stepsarray<FormsStep>não
schema.steps[].idstringsim
schema.steps[].titlestringsim
schema.steps[].field_idsarray<string>sim
schema.settingsFormsSettingssim
schema.settings.submit_labelstringnão
schema.settings.thank_you_messagestringnão
schema.settings.redirect_urlstring | nullnão
schema.settings.honeypotbooleannão

Se true, adiciona campo axuz_hp e rejeita submits com valor.

schema.settings.double_opt_inbooleannão
schema.settings.triggersarray<FormsTrigger>não
schema.settings.triggers[].idstringsim

client uuid

schema.settings.triggers[].typestringsim

enum: "email", "webhook", "calendar_event", "workspace_task"

schema.settings.triggers[].enabledbooleansim
schema.settings.triggers[].labelstringnão
schema.settings.triggers[].mappingobjectnão
schema.settings.triggers[].configobjectnão

Shape depende de type: - email: { to: string[] } - webhook: { url: string, secret?: string } - calendar_event/workspace_task: fields específicos do módulo.

schema.settings.notify_emailsarray<string<email>>não

Legacy Fase 178. Promovido em memória pra Triggers no read.

schema.settings.webhook_urlstringnão
schema.settings.webhook_secretstringnão
layoutstringnão
{
  "name": "string",
  "slug": "string",
  "description": "string",
  "schema": {
    "fields": [
      {
        "id": "string",
        "type": "text",
        "label": "string",
        "name": "string",
        "required": true,
        "placeholder": "string",
        "help_text": "string",
        "default": "string",
        "options": [],
        "max_length": 1,
        "min": 1,
        "max": 1,
        "rows": 1,
        "pattern": "string",
        "extra": {}
      }
    ],
    "steps": [
      {
        "id": "string",
        "title": "string",
        "field_ids": []
      }
    ],
    "settings": {
      "submit_label": "string",
      "thank_you_message": "string",
      "redirect_url": "string",
      "honeypot": true,
      "double_opt_in": true,
      "triggers": [
        {}
      ],
      "notify_emails": [
        "pessoa@example.test"
      ],
      "webhook_url": "string",
      "webhook_secret": "string"
    }
  },
  "layout": "string"
}

Respostas

201

Criado

NomeTipoObrigatórioDescrição
idstring<uuid>sim
team_idstring<uuid>sim
slugstringsim
namestringsim
descriptionstring | nullnão
schemaFormsFormSchemasim
schema.fieldsarray<FormsField>sim
schema.fields[].idstringsim
schema.fields[].typestringsim

enum: "text", "email", "phone", "textarea", "number", "select", "radio", "checkbox", "date", "url", "file", "hidden"

schema.fields[].labelstringnão
schema.fields[].namestringsim
schema.fields[].requiredbooleannão
schema.fields[].placeholderstringnão
schema.fields[].help_textstringnão
schema.fields[].defaultanynão
schema.fields[].optionsarray<FormsFieldOption>não
schema.fields[].options[].valuestringsim
schema.fields[].options[].labelstringsim
schema.fields[].max_lengthinteger | nullnão
schema.fields[].minnumber | nullnão
schema.fields[].maxnumber | nullnão
schema.fields[].rowsinteger | nullnão
schema.fields[].patternstringnão
schema.fields[].extraobjectnão
schema.stepsarray<FormsStep>não
schema.steps[].idstringsim
schema.steps[].titlestringsim
schema.steps[].field_idsarray<string>sim
schema.settingsFormsSettingssim
schema.settings.submit_labelstringnão
schema.settings.thank_you_messagestringnão
schema.settings.redirect_urlstring | nullnão
schema.settings.honeypotbooleannão

Se true, adiciona campo axuz_hp e rejeita submits com valor.

schema.settings.double_opt_inbooleannão
schema.settings.triggersarray<FormsTrigger>não
schema.settings.triggers[].idstringsim

client uuid

schema.settings.triggers[].typestringsim

enum: "email", "webhook", "calendar_event", "workspace_task"

schema.settings.triggers[].enabledbooleansim
schema.settings.triggers[].labelstringnão
schema.settings.triggers[].mappingobjectnão
schema.settings.triggers[].configobjectnão

Shape depende de type: - email: { to: string[] } - webhook: { url: string, secret?: string } - calendar_event/workspace_task: fields específicos do módulo.

schema.settings.notify_emailsarray<string<email>>não

Legacy Fase 178. Promovido em memória pra Triggers no read.

schema.settings.webhook_urlstringnão
schema.settings.webhook_secretstringnão
layoutstringsim

Layout resolvido via ResolveLayout.

statusstringsim

enum: "draft", "published", "archived"

submit_countintegersim
created_bystring<uuid> | nullnão
created_atstring<date-time>sim
updated_atstring<date-time>sim
deleted_atstring<date-time> | nullnão

400

Parâmetro/body inválido

NomeTipoObrigatórioDescrição
errorstringsim

401

Sem auth ou JWT inválido

NomeTipoObrigatórioDescrição
errorstringsim

403

Sem forms:write no team (missing_permission: forms:write; guest é read-only, W-012 S-3).

NomeTipoObrigatórioDescrição
errorstringsim

409

Slug já em uso

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro inesperado

NomeTipoObrigatórioDescrição
errorstringsim

503

PDP (auth_api) indisponível; fechado, com Retry-After (permission_check_unavailable).

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-forms.axuz.net/teams/TEAM_ID/forms/' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","description":"string","schema":{"fields":[{"id":"string","type":"text","label":"string","name":"string","required":true,"placeholder":"string","help_text":"string","default":"string","options":[],"max_length":1,"min":1,"max":1,"rows":1,"pattern":"string","extra":{}}],"steps":[{"id":"string","title":"string","field_ids":[]}],"settings":{"submit_label":"string","thank_you_message":"string","redirect_url":"string","honeypot":true,"double_opt_in":true,"triggers":[{}],"notify_emails":["pessoa@example.test"],"webhook_url":"string","webhook_secret":"string"}},"layout":"string"}'

Node.js

const res = await fetch("https://api-forms.axuz.net/teams/TEAM_ID/forms/", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "slug": "string",
    "description": "string",
    "schema": {
      "fields": [
        {
          "id": "string",
          "type": "text",
          "label": "string",
          "name": "string",
          "required": true,
          "placeholder": "string",
          "help_text": "string",
          "default": "string",
          "options": [],
          "max_length": 1,
          "min": 1,
          "max": 1,
          "rows": 1,
          "pattern": "string",
          "extra": {}
        }
      ],
      "steps": [
        {
          "id": "string",
          "title": "string",
          "field_ids": []
        }
      ],
      "settings": {
        "submit_label": "string",
        "thank_you_message": "string",
        "redirect_url": "string",
        "honeypot": true,
        "double_opt_in": true,
        "triggers": [
          {}
        ],
        "notify_emails": [
          "pessoa@example.test"
        ],
        "webhook_url": "string",
        "webhook_secret": "string"
      }
    },
    "layout": "string"
  }),
});
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-forms.axuz.net/teams/TEAM_ID/forms/",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "name": "string",
        "slug": "string",
        "description": "string",
        "schema": {
            "fields": [
                {
                    "id": "string",
                    "type": "text",
                    "label": "string",
                    "name": "string",
                    "required": True,
                    "placeholder": "string",
                    "help_text": "string",
                    "default": "string",
                    "options": [],
                    "max_length": 1,
                    "min": 1,
                    "max": 1,
                    "rows": 1,
                    "pattern": "string",
                    "extra": {},
                },
            ],
            "steps": [
                {
                    "id": "string",
                    "title": "string",
                    "field_ids": [],
                },
            ],
            "settings": {
                "submit_label": "string",
                "thank_you_message": "string",
                "redirect_url": "string",
                "honeypot": True,
                "double_opt_in": True,
                "triggers": [
                    {},
                ],
                "notify_emails": [
                    "pessoa@example.test",
                ],
                "webhook_url": "string",
                "webhook_secret": "string",
            },
        },
        "layout": "string",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())