Convites

Um convite liga uma pesquisa a um respondente. Ele tem uma data limite para responder e registra as datas de envio do convite, de abertura e de envio da resposta. Corresponde à tela Pesquisas de satisfação, do módulo Operacional.

O convite é identificado pelo uuid, usado nos caminhos. A pesquisa é indicada pelo uuid no caminho.

A criação de um convite pela API apenas registra o convite: nenhuma mensagem é enviada ao respondente.

Endpoints

Método	Caminho	Descrição
GET	/operational/surveys/{survey_uuid}/invites	Lista os convites da pesquisa
POST	/operational/surveys/{survey_uuid}/invites	Cria um convite para a pesquisa
GET	/operational/surveys/{survey_uuid}/invites/{uuid}	Consulta um convite
DELETE	/operational/surveys/{survey_uuid}/invites/{uuid}	Apaga um convite

GET /operational/surveys/{survey_uuid}/invites

Lista os convites de uma pesquisa.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
survey_uuid	Sim	uuid da pesquisa
column	Não	Coluna de ordenação, com o nome da tabela (por exemplo, surveys_invites.expires_at)
order	Não	Direção da ordenação: asc ou desc
per_page	Não	Quantidade de registros por página. Se omitido, a lista vem completa
page	Não	Número da página, quando per_page é informado

Resposta (200). Com per_page, a resposta é paginada. Sem per_page, é uma lista direta. Cada item traz os campos do convite (id, uuid, survey_id, type_id, respondent_id, expires_at, sent_at, opened_at, submitted_at), além de survey_name, survey_invite_type (nome do tipo), user_create_name e user_update_name.

curl -X GET "https://api.pedagogo.app/operational/surveys/<uuid-da-pesquisa>/invites?per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /operational/surveys/{survey_uuid}/invites

Cria um convite para a pesquisa. O servidor gera o uuid do convite e preenche o usuário que criou o registro. Esta chamada não envia mensagem ao respondente.

Corpo

Campo	Obrigatório	Tipo	Descrição
type_id	Sim	Número inteiro	Tipo da pesquisa. Use o id de GET /operational/surveys/types
respondent_id	Sim	Número inteiro	Identificador numérico do respondente
expires_at	Sim	Data	Data limite para responder, por exemplo 2026-12-31
sent_at	Não	Data	Data de envio do convite
opened_at	Não	Data	Data de abertura do convite
submitted_at	Não	Data	Data de envio da resposta, se informada no cadastro

Resposta (200). O convite criado. Use o uuid do convite nos caminhos de consulta e exclusão.

curl -X POST https://api.pedagogo.app/operational/surveys/<uuid-da-pesquisa>/invites \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"type_id": 1, "respondent_id": 123, "expires_at": "2026-12-31"}'

GET /operational/surveys/{survey_uuid}/invites/{uuid}

Consulta um convite.

Resposta (200). O convite, com os campos listados na listagem.

DELETE /operational/surveys/{survey_uuid}/invites/{uuid}

Apaga um convite. A exclusão é lógica.

Resposta (200): {"message": "Deleted successfully."}.