Recaudo Docs

Calendário

Eventos

Crie e gerencie a partir do seu site os eventos do Recaudo: webinars, oficinas, cursos ou reuniões. Cada evento publicado tem sua página de inscrição em recaudo.app/e/{sua-conta}/{evento}, com os mesmos campos que você vê no painel.

GET /v1/events Lista seus eventos
POST /v1/events Cria um evento
GET /v1/events/{id} Consulta um evento
PATCH /v1/events/{id} Edita um evento
DELETE /v1/events/{id} Exclui um evento
GET /v1/events/{id}/registrations Lista quem se inscreveu

Criar um evento

Corpo
{
    "name": "Webinar: mantenimiento preventivo",
    "description": "Sesión en vivo con preguntas al final.",
    "location_type": "online",
    "format": "webinar",
    "frequency": "one_time",
    "date": "2026-11-18",
    "start_time": "19:00",
    "end_time": "20:30",
    "meeting_url": "https://meet.example.com/abc-defg-hij",
    "max_attendees": 150,
    "status": "published",
    "custom_fields": [
        {
            "label": "Puesto",
            "type": "select",
            "required": true,
            "options": [
                "Dirección",
                "Operación",
                "Ventas"
            ]
        },
        {
            "label": "Ciudad",
            "type": "text",
            "required": true
        }
    ]
}
Campo Tipo Obrigatório Descrição
name string Sim Nome do evento. O slug da página sai daqui.
location_type string Sim online, presencial, hibrido (híbrido) ou on_demand.
frequency string Sim one_time (uma data), recurring (se repete) ou evergreen (sem data, sempre disponível).
date date Depende Data (YYYY-MM-DD), de hoje em diante. Obrigatória exceto em evergreen.
start_time string Depende Hora de início (HH:MM, 24 h). Obrigatória exceto em evergreen.
end_time string Não Hora de término (HH:MM), depois do início.
format string Não webinar, demo, taller (oficina), conferencia (conferência), reunion (reunião) ou otro (outro).
description string Não Texto da página do evento (até 5.000 caracteres).
status string Não draft (rascunho, padrão) ou published. Ao editar, também cancelled ou completed.
location string Não Endereço ou local, para eventos presenciais.
latitude number Não Latitude do local, para mostrar o mapa.
longitude number Não Longitude do local, para mostrar o mapa.
meeting_url url Não Link da sessão ao vivo (Zoom, Meet, Teams).
content_url url Não Link da gravação ou material, para on_demand.
image_url url Não Imagem de capa (URL pública).
max_attendees integer Não Vagas máximas (1 a 10.000). Sem valor, vagas ilimitadas.
requires_payment boolean Não true se a inscrição é paga.
price number Depende Preço em decimais. Obrigatório se requires_payment for true.
currency string Não Moeda ISO de 3 letras (padrão MXN).
is_invitation_only boolean Não true para que o evento não apareça na sua lista pública.
recurrence_rule object Depende Obrigatório em recurring: {"pattern": "weekly|biweekly|monthly", "end_date": "YYYY-MM-DD", "occurrences": 2-52}.
custom_fields array Não Perguntas extras do formulário de inscrição (até 30).
  • custom_fields: lista de {label, type, required, options}. type pode ser text, email, tel, number, select ou textarea. Em select, options é uma lista ["A", "B"] ou um texto separado por vírgulas.
  • A resposta traz o evento com id, slug, public_url (a página de inscrição), registrations_count e available_spots.

Editar, excluir e listar

  • PATCH /v1/events/{id} altera só os campos que você enviar. Se enviar custom_fields, substitui a lista inteira.
  • DELETE /v1/events/{id} exclui o evento e sua página deixa de estar disponível. As inscrições são mantidas.
  • GET /v1/events aceita status, search (por nome), upcoming=true (de hoje em diante), limit e page.

Inscrições de um evento

GET /v1/events/{id}/registrations retorna cada pessoa inscrita: attendee_name, attendee_email, attendee_phone, status (registered, paid, attended, cancelled, no_show), amount_paid, custom_data (as respostas às suas perguntas, com o label) e url_params (UTM de onde veio). Filtre com status, limit e page.

Esta página ajudou? Obrigado por avisar.
Esc