POST Send document

Changed on

Este endpoint permite o envio do documento anexado para os canais informados, como e-mail ou WhatsApp. É uma forma prática de compartilhar o arquivo diretamente com os destinatários desejados.

E-mails recebem o arquivo em anexo; números de celular recebem uma mensagem de WhatsApp com o link de visualização do documento. A resposta é sempre 200, mesmo que algum envio falhe.

post/api/files/send

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/files/send
  • Auth
    API key in header Authorization

Request body

document_keystring required

Document Key do documento.

messagestring required

Mensagem enviada para os destinatários (2 a 255 caracteres).

contactstring[] required

E-mails e/ou celulares com WhatsApp (DDD + 9 + número), mínimo 1.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Documento enviado para os contatos com sucesso!"
}

Changes

    • breaking

      the request property's minLength was increased from 0 to 2

    • warning

      the request property's maxLength was set to 255

    • info

      added the non-success response with the status