Skip to main content
POST
Criação de documento anexado à proposta

Authorizations

Authorization
string
header
required

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.

Path Parameters

id
string<uuid>
required

UUID da proposta.

Body

application/json
title
string

Título do documento. Quando omitido ou vazio, o documento nasce como "Documento sem título".

Maximum string length: 180
folder_id
string<uuid>

Pasta da biblioteca que vai receber o documento. Omita para criar na raiz.

visibility
enum<string>
default:PRIVATE

Visibilidade do documento na biblioteca.

Available options:
PRIVATE,
RESTRICTED,
COMPANY
content_markdown
string

Conteúdo inicial da página principal, em Markdown. Não pode referenciar imagens de outro documento.

Maximum string length: 200000

Response

Documento criado e anexado à proposta.

id
string<uuid>
proposal_id
string<uuid> | null
draft_token
string<uuid> | null

Sempre null na API externa.

kind
enum<string>
Available options:
FILE,
DOCUMENT
status
enum<string>

Anexos criados pela API externa já nascem READY.

Available options:
UPLOADING,
READY
position
integer
created_at
string<date-time>
updated_at
string<date-time>
created_by_user
object
file
object | null

Dados do arquivo; presente somente quando kind = FILE.

document
object | null

Dados do documento da biblioteca; presente somente quando kind = DOCUMENT.