> ## Documentation Index > Fetch the complete documentation index at: https://docs.wegly.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Criação de documento anexado à proposta > Cria um documento na biblioteca de documentos da Wegly, com conteúdo inicial opcional em Markdown, e o anexa à proposta. O documento pertence ao usuário criador da chave, nasce `PRIVATE` por padrão e pode ser lido pelos anexos por quem enxerga a proposta. Remover o anexo não apaga o documento da biblioteca. Exige as permissões `crm/proposal.update` e `crm/document.create` na chave e no usuário criador da chave, além de lead ou negócio aberto e não arquivado. A inclusão é registrada no histórico da proposta. ## OpenAPI ````yaml /openapi.json post /integrations/external/proposals/{id}/attachments/documents openapi: 3.0.3 info: title: >- Integração Externa - Leads, Oportunidades, Tarefas, Arquivos, Propostas, Chats, Satisfação e Campos Personalizados version: 1.0.0 description: > Documentação oficial da API externa da Wegly para campos personalizados, leads, oportunidades, tarefas, arquivos, propostas, chats e satisfação (`/integrations/external/custom-fields`, `/integrations/external/files`, `/integrations/external/leads`, `/integrations/external/deals`, `/integrations/external/tasks`, `/integrations/external/proposals`, `/integrations/external/chats` e `/integrations/external/satisfaction`). Todas as descrições estão em português e refletem as regras aplicadas pelo serviço. servers: - url: https://api.wegly.com.br description: Ambiente de produção Wegly security: - bearerAuth: [] tags: - name: Campos Personalizados description: >- Consulta dos campos personalizados disponíveis para uso nas integrações externas. - name: Arquivos description: >- Upload e consulta de arquivos vinculados diretamente a leads ou oportunidades. Arquivos de proposta usam as rotas de anexos em Propostas. - name: Leads description: >- Operações de listagem, criação, consulta e atualização de leads via integração externa. - name: Oportunidades description: Operações de criação de oportunidades (deals) via integração externa. - name: Tarefas description: >- Operações de listagem, criação, consulta, atualização e remoção de tarefas vinculadas a leads, oportunidades, entregas, pessoas, organizações ou clientes. - name: Satisfação description: >- Geração de links públicos para formulários de satisfação via integração externa. - name: Propostas description: >- Operações de listagem, criação, consulta, atualização e remoção de propostas via integração externa, incluindo seus anexos (arquivos e documentos da biblioteca). - name: Chats description: >- Operações principais de listagem, criação, consulta e resumo de não lidas de chats via integração externa. paths: /integrations/external/proposals/{id}/attachments/documents: post: tags: - Propostas summary: Criação de documento anexado à proposta description: >- Cria um documento na biblioteca de documentos da Wegly, com conteúdo inicial opcional em Markdown, e o anexa à proposta. O documento pertence ao usuário criador da chave, nasce `PRIVATE` por padrão e pode ser lido pelos anexos por quem enxerga a proposta. Remover o anexo não apaga o documento da biblioteca. Exige as permissões `crm/proposal.update` e `crm/document.create` na chave e no usuário criador da chave, além de lead ou negócio aberto e não arquivado. A inclusão é registrada no histórico da proposta. parameters: - name: id in: path required: true schema: type: string format: uuid description: UUID da proposta. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProposalAttachmentDocument' responses: '201': description: Documento criado e anexado à proposta. content: application/json: schema: $ref: '#/components/schemas/ProposalAttachment' '400': description: >- Payload inválido, conteúdo com imagem de outro documento ou menção a usuário fora da empresa, limite de 50 anexos atingido ou lead ou negócio da proposta fechado ou arquivado. '401': description: >- Chave de integração ausente, inválida, inativa ou expirada, ou domínio de origem não autorizado para a chave. '403': description: >- Permissão `crm/proposal.update` ou `crm/document.create` ausente na chave ou no usuário criador da chave, ou pasta sem permissão de criação. '404': description: >- Proposta ou pasta não encontrada, ou proposta fora do escopo de leitura do usuário criador da chave. '429': description: Limite de requisições atingido. headers: Retry-After: description: Tempo de espera em segundos, quando enviado. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ExternalApiError' components: schemas: CreateProposalAttachmentDocument: type: object properties: title: type: string maxLength: 180 description: >- Título do documento. Quando omitido ou vazio, o documento nasce como "Documento sem título". folder_id: type: string format: uuid description: >- Pasta da biblioteca que vai receber o documento. Omita para criar na raiz. visibility: type: string enum: - PRIVATE - RESTRICTED - COMPANY default: PRIVATE description: Visibilidade do documento na biblioteca. content_markdown: type: string maxLength: 200000 description: >- Conteúdo inicial da página principal, em Markdown. Não pode referenciar imagens de outro documento. ProposalAttachment: type: object properties: id: type: string format: uuid proposal_id: type: string format: uuid nullable: true draft_token: type: string format: uuid nullable: true description: Sempre `null` na API externa. kind: type: string enum: - FILE - DOCUMENT status: type: string enum: - UPLOADING - READY description: Anexos criados pela API externa já nascem `READY`. position: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time created_by_user: $ref: '#/components/schemas/ProposalAttachmentUserSummary' file: type: object allOf: - $ref: '#/components/schemas/ProposalAttachmentFile' nullable: true document: type: object allOf: - $ref: '#/components/schemas/ProposalAttachmentDocumentSummary' nullable: true ExternalApiError: type: object properties: statusCode: type: integer message: oneOf: - type: string - type: array items: type: string error: type: string description: >- Formato de erro do HTTP/NestJS; os campos presentes variam conforme a exceção. ProposalAttachmentUserSummary: type: object properties: id: type: string format: uuid name: type: string avatar: type: string nullable: true ProposalAttachmentFile: type: object description: Dados do arquivo; presente somente quando `kind = FILE`. properties: name: type: string extension: type: string nullable: true description: Extensão em minúsculas, sem o ponto. mime_type: type: string nullable: true size_bytes: type: integer can_preview: type: boolean description: >- Arquivo pronto, em formato com visualização rápida no CRM e com até 50 MB. can_play_inline: type: boolean description: Arquivo pronto em MP3 ou MP4, reproduzível pelo player do CRM. ProposalAttachmentDocumentSummary: type: object description: >- Dados do documento da biblioteca; presente somente quando `kind = DOCUMENT`. properties: id: type: string format: uuid title: type: string summary: type: string nullable: true workflow_status: type: string enum: - DRAFT - PUBLISHED has_unpublished_changes: type: boolean published_version: type: integer nullable: true updated_at: type: string format: date-time last_edited_by_user: type: object allOf: - $ref: '#/components/schemas/ProposalAttachmentUserSummary' nullable: true is_available: type: boolean description: '`false` quando o documento está na lixeira da biblioteca.' access: type: object description: >- O que o usuário criador da chave pode fazer com o documento na biblioteca. properties: can_open: type: boolean can_edit: type: boolean securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- Chave de integração com prefixo wegly_, enviada em Authorization: Bearer . Não é JWT. A chave deve estar ativa, não excluída e dentro da validade. Com allowed_domain, Origin (ou Referer na ausência de Origin) precisa informar o hostname permitido. A empresa e as permissões são obtidas pela chave. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.