Referência da API

Templates hospedados

Crie rascunhos, renderize, teste, versione, publique e envie conteúdo reutilizável.

Filtrar templates hospedados

GET/templates

Chave de API

Listar templates hospedados

Parâmetros de querylifecyclequery

Requisição

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

Resposta 200

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

POST/templates

Chave de API

Criar um template hospedado

Requisição

curl https://sendhq.cc/api/v1/templates \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Account welcome","key":"account-welcome","starter":"welcome"}'

Resposta 201

{
  "template": {
    "id": "tmpl_…",
    "key": "account-welcome"
  }
}

GET/templates/:id

Chave de API

Obter rascunhos, versões publicadas e uso

Requisição

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

Resposta 200

{
  "template": {
    "id": "tmpl_…"
  },
  "versions": [],
  "draft": null,
  "activeVersion": null,
  "usage": []
}

PUT/templates/:id/draft

Chave de API

Salvar automaticamente o rascunho de um template

Requisição

curl https://sendhq.cc/api/v1/templates/id_value/draft \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"revision":1,"name":"Account welcome","subjectTemplate":"Welcome, {{first_name}}","htmlTemplate":"<h1>Welcome, {{first_name}}</h1>","textTemplate":"Welcome, {{first_name}}","variables":[{"key":"first_name","type":"string","required":true}],"sampleData":{"first_name":"Asha"}}'

Resposta 200

{
  "draft": {
    "id": "tmplv_…",
    "revision": 2
  }
}

POST/templates/:id/draft

Chave de API

Criar um novo rascunho a partir da versão publicada

Requisição

curl https://sendhq.cc/api/v1/templates/id_value/draft \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 201

{
  "draft": {
    "id": "tmplv_…",
    "revision": 1
  }
}

POST/templates/:id/render

Chave de API

Renderizar a saída exata do servidor

Requisição

curl https://sendhq.cc/api/v1/templates/id_value/render \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":{"first_name":"Asha"}}'

Resposta 200

{
  "subject": "Welcome, Asha",
  "html": "<h1>Welcome, Asha</h1>",
  "text": "Welcome, Asha",
  "findings": []
}

POST/templates/:id/test

Chave de API

Enviar um snapshot de teste

Requisição

curl https://sendhq.cc/api/v1/templates/id_value/test \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":["owner@example.com"],"from":"hello@example.com","data":{"first_name":"Asha"}}'

Resposta 201

{
  "id": "em_…",
  "isTest": true
}

POST/templates/:id/publish

Chave de API

Publicar uma versão imutável do template

Requisição

curl https://sendhq.cc/api/v1/templates/id_value/publish \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 201

{
  "version": {
    "id": "tmplv_…",
    "state": "published"
  }
}

POST/templates/:id/archive

Chave de API

Arquivar um template

Requisição

curl https://sendhq.cc/api/v1/templates/id_value/archive \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "template": {
    "id": "tmpl_…",
    "lifecycle": "archived"
  }
}

POST/templates/:id/restore

Chave de API

Restaurar um template arquivado

Requisição

curl https://sendhq.cc/api/v1/templates/id_value/restore \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Resposta 200

{
  "template": {
    "id": "tmpl_…",
    "lifecycle": "active"
  }
}