Nunciatura Provista

API Documentation V1

Substituir colaborador

Revoga o colaborador atual e compartilha com um novo email

Endpoint Protected

Descrição

Revoga o token do colaborador atual e envia um novo convite por email para outro colaborador. O rascunho do questionário é mantido. Apenas para questionários compartilháveis (G1Q1 e G1Q2) e enquanto não finalizado.

Detalhes do Endpoint

VERBO

POST

URL BASE

http://api.provisao.hmg.nabrasil.org.br/v1

ENDPOINT

/questionnaires/{questionnaire}/answers/{answer}/substitute-share

Body (JSON)

{
  "email": "novo-colaborador@exemplo.com"
}

Resposta 200

{
  "success": true,
  "message": "Colaborador substituído com sucesso. O novo colaborador receberá um email com o link de acesso.",
  "data": {
    "shared_with": "novo-colaborador@exemplo.com",
    "shared_waiting_first_access": true
  }
}

403 quando o questionário não pode ser compartilhado (ex.: G1Q3) ou a resposta já está finalizada.

Códigos de Resposta

Código Descrição
200 Colaborador substituído; email enviado
403 Questionário não compartilhável ou já finalizado
422 Email inválido