# Envio de Documentos por email

{% openapi src="/files/LrXEg3IjIacAycCz7IWE" path="/api/email/document" method="patch" %}
[TOConline Open API.yaml](https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2Fgit-blob-1f7bd9dd692716d3f3f93d9c9a4f7226d78277e3%2FTOConline%20Open%20API.yaml?alt=media)
{% endopenapi %}

{% code overflow="wrap" fullWidth="false" %}

```batch
curl -v -X PATCH -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' -d '<payload JSON>' '<API_URL>/email/document/<id do documento ou recibo>'
```

{% endcode %}

No pedido acima, o *access\_token* é o *token* de acesso válido devolvido pelo serviço de OAuth e o *id do documento ou recibo* é o "id" interno do documento ou do recibo (cabeçalho), o devolvido no campo "id" da resposta ao seu pedido de criação. O *payload* JSON a enviar contém a seguinte informação:

{% code title="Payload" %}

```json
{
  "data": {
    "type": "email/document",                                  // [OBRIGATÓRIO]
    "id": "<id do documento ou do recibo>",                    // [OBRIGATÓRIO] Este "id" é o devolvido na resposta ao pedido de criação do cabeçalho do documento ou do recibo, ver acima
    "attributes": {
      "type": "Document|Receipt",                              // [OPCIONAL] Por omissão "Document": "Document" para documentos de venda, "Receipt" para recibos
      "to_email": "email.do.destinatario@mail.mail",           // [OPCIONAL] Por omissão é o endereço de email do cliente; se não existir tem que ser indicado. Podem ser vários, separados por ,
      "from_email": "email.do.remetente@mail.mail",            // [OPCIONAL] Por omissão é o endereço no-reply de email do sistema (TOConline, Business...)
      "from_name": "Nome do remetente",                        // [OPCIONAL]
      "subject": "Assunto da mensagem"                         // [OPCIONAL] Por omissão é o assunto padrão do sistema ("(Nome da empresa) enviou-lhe um documento/recibo através do (TOConline, Business...)")
    }
  }
}
```

{% endcode %}

{% code title="Exemplo de Response" %}

```json
{
    "success": true,
    "to_addresses": "email.do.destinatario@mail.mail"
}
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api-docs.toconline.pt/apis/vendas/envio-de-documentos-por-email.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.