Referência da API

Rascunhos e anexos

Crie fluxos de composição com armazenamento privado de anexos.

Filtrar rascunhos e anexos

POST/drafts

Chave de API

Criar um rascunho de composição

Requisição

curl https://sendhq.cc/api/v1/drafts \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"hello@example.com","to":["customer@example.net"],"subject":"Hello"}'

Resposta 201

{
  "id": "dr_…",
  "attachments": []
}

GET/drafts

Chave de API

Listar os rascunhos de composição

Requisição

curl https://sendhq.cc/api/v1/drafts \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "data": [],
  "count": 0
}

GET/drafts/:id

Chave de API

Obter um rascunho e seus anexos

Requisição

curl https://sendhq.cc/api/v1/drafts/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "id": "dr_…",
  "attachments": []
}

PUT/drafts/:id

Chave de API

Substituir o conteúdo do rascunho

Requisição

curl https://sendhq.cc/api/v1/drafts/id_value \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"hello@example.com","to":["customer@example.net"],"subject":"Updated subject","text":"Updated body"}'

Resposta 200

{
  "id": "dr_…"
}

DELETE/drafts/:id

Chave de API

Descartar um rascunho

Requisição

curl https://sendhq.cc/api/v1/drafts/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "ok": true
}

POST/drafts/:id/attachments

Chave de API

Enviar um anexo para um rascunho

Envie os bytes brutos do arquivo. Defina Content-Type e X-Filename. Uma mensagem pode conter no máximo 10 arquivos e 10 MB no total.

Cabeçalhos opcionaisX-Filename

Requisição

curl https://sendhq.cc/api/v1/drafts/id_value/attachments \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/pdf" \
  -H "X-Filename: invoice.pdf" \
  --data-binary @invoice.pdf

Resposta 201

{
  "id": "att_…",
  "filename": "invoice.pdf",
  "sizeBytes": 48231,
  "available": true
}

GET/attachments/:id

Chave de API

Baixar um anexo privado

Requisição

curl https://sendhq.cc/api/v1/attachments/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

DELETE/attachments/:id

Chave de API

Excluir um anexo privado

Requisição

curl https://sendhq.cc/api/v1/attachments/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "ok": true
}

GET/sending-identities

Chave de API

Listar as identidades de remetente verificadas

Requisição

curl https://sendhq.cc/api/v1/sending-identities \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "domains": [],
  "addresses": [],
  "localParts": []
}