SigningSessions

Reenviar convite de assinatura

Reenvia o convite de uma sessão ACTIVE — por exemplo, quando o original caiu no spam ou se perdeu. Gera um link novo (novo clientSecret); o link anterior continua válido até a sessão expirar.

Sem corpo, reenvia pelos canais com que o signatário foi criado (deliverVia); sessões sem canais gravados reenviam por e-mail. Informe deliverVia no corpo para escolher outros canais nesta chamada.

Limitado a um reenvio a cada 60 segundos por sessão: dentro desse intervalo a chamada retorna 409 com o tempo restante. Também retorna 409 quando a sessão não está ACTIVE, ou quando o e-mail é pedido e a sessão não tem e-mail do signatário.

Reenvios por WhatsApp e Telegram consomem a cota de mensagens do tenant: esgotada, a chamada retorna 429 antes de gerar link ou enviar qualquer mensagem.

Requer scope transactions:write.

post/v1/signing-sessions/{sessionId}/resend-invite

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/v1/signing-sessions/{sessionId}/resend-invite
  • Auth: HTTP bearer

Path parameters

sessionIdstring required

Identificador único da sessão de assinatura.

Request body

deliverViastring[]

Canais para este reenvio. Omitido: os canais com que o signatário foi criado, ou e-mail para sessões sem canais gravados. Mesmas regras de deliverVia na criação da sessão, inclusive a cota de mensagens (429).

Example request

{
  "deliverVia": [
    "whatsapp"
  ]
}

Response

Convite reenviado.

sessionIdstring required
transactionIdstring required
tostring email

E-mail para o qual o convite foi reenviado. Presente só quando o reenvio incluiu e-mail.

whatsappInviteSentboolean

true quando a Meta aceitou a mensagem, o que não confirma a entrega. Omitido em qualquer outro caso.

telegramInviteSentboolean

Resultado do envio pelo bot do Telegram. Presente sempre que o reenvio incluiu telegram; false quando o convite não chegou.

resentAtstring date-time required

Data/hora do reenvio (ISO 8601 UTC).

Example response

{
  "sessionId": "ss_01JXYZ...",
  "transactionId": "tx_01JXYZ..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.