ARararahq
Formulários

Desativar formulário

Changed on

Marca o formulário como DEPRECATED. As respostas já recebidas ficam guardadas e o botão deixa de abrir para quem recebeu a mensagem antes. Só formulário publicado pode ser desativado (409 FLOW_NOT_PUBLISHED). Permissão: TEMPLATES_WRITE.

post/v1/flows/{id}/deprecate

Request

Path parameters

idstring uuid required

ID do formulário.

Response

Formulário desativado

idstring uuid required

Use como flowId no envio e no botão FLOW do template.

namestring required
category'SIGN_UP' | 'LEAD_GENERATION' | 'SURVEY' | 'APPOINTMENT_BOOKING' | 'CONTACT_US' | 'OTHER' required
status'DRAFT' | 'PUBLISHED' | 'DEPRECATED' required

DRAFT: criado, mas a publicação falhou (veja publishError). PUBLISHED: no ar, pode ser enviado. DEPRECATED: desativado.

responseCountinteger required

Total de respostas recebidas.

publishErrorstring nullable

Preenchido só quando o formulário foi criado mas a publicação falhou.

createdAtstring date-time nullable
publishedAtstring date-time nullable

Example response

{
  "id": "0b7e6a52-3c1d-4f7a-9a55-2f4f6f1f9c10",
  "name": "Captar contato",
  "category": "LEAD_GENERATION",
  "status": "PUBLISHED",
  "definition": {
    "title": "Fale com a gente",
    "intro": "Leva menos de um minuto.",
    "submitLabel": "Enviar",
    "fields": [
      {
        "key": "nome",
        "label": "Seu nome",
        "type": "TEXT",
        "required": true,
        "options": []
      },
      {
        "key": "email",
        "label": "Seu melhor e-mail",
        "type": "EMAIL",
        "required": true,
        "options": []
      },
      {
        "key": "interesse",
        "label": "O que você procura?",
        "type": "SELECT",
        "required": true,
        "options": [
          {
            "id": "falar_com_vendas",
            "title": "Falar com vendas"
          },
          {
            "id": "suporte",
            "title": "Suporte"
          }
        ]
      }
    ]
  },
  "responseCount": 42,
  "publishError": null,
  "createdAt": "2026-09-15T14:30:00Z",
  "publishedAt": "2026-09-15T14:30:04Z"
}

Changes