Ir para o conteúdo

Modelo de Email

Uma mensagem de email preparada que pode ser utilizada para inicializar uma campanha ou email transacional.

Endpoints

Método URL
GET /email_template/<template>
POST /email_template
PUT /email_template/<template>
DELETE /email_template/<template>

GET /email_template/<template>

Payload: Sem payload.

Devolve: O modelo.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  https://app.duo.pt/email_template/{template_id}

Response:

{
  "success": true,
  "data": {
    "email_template": {
      "id": 1,
      "owner": 1,
      "name": "Monthly Newsletter",
      "message": "<html><body>Hi {{name}}</body></html>",
      "shared_with_children": false,
      "tags": "",
      "block_editor_type": "",
      "block_editor_content": null
    }
  }
}

POST /email_template

Parâmetro Tipo Descrição
name string Nome do modelo
message string Código HTML da mensagem
block_editor_type string "" (sem editor) ou "unlayer"
block_editor_content string (opcional) String JSON com a fonte da mensagem para o editor de blocos
shared_with_children boolean Permitir que utilizadores filhos hierárquicos utilizem este modelo

Devolve: O novo modelo.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "name=My+Template&message=<html><body>Hi+{{name}}</body></html>&block_editor_type=" \
  https://app.duo.pt/email_template

Response:

{
  "success": true,
  "data": {
    "email_template": {
      "id": 1,
      "owner": 1,
      "name": "Monthly Newsletter",
      "message": "<html><body>Hi {{name}}</body></html>",
      "shared_with_children": false,
      "tags": null,
      "block_editor_type": "",
      "block_editor_content": null
    },
    "success": true
  }
}

PUT /email_template/<template>

Mesmo payload que o POST.

Devolve: O modelo editado.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X PUT \
  -d "name=Updated+Template&message=<html><body>Updated</body></html>&block_editor_type=" \
  https://app.duo.pt/email_template/{template_id}

Response:

{
  "success": true,
  "data": {
    "email_template": {
      "id": 1,
      "owner": 1,
      "name": "Monthly Newsletter",
      "message": "<html><body>Hi {{name}}</body></html>",
      "shared_with_children": false,
      "tags": "",
      "block_editor_type": "",
      "block_editor_content": null
    },
    "success": true
  }
}

DELETE /email_template/<template>

Payload: Sem payload.

Devolve: O modelo eliminado.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X DELETE \
  https://app.duo.pt/email_template/{template_id}

Response:

{
  "success": true,
  "data": {
    "template": {
      "id": 1,
      "owner": 1,
      "name": "Monthly Newsletter",
      "message": "<html><body>Hi {{name}}</body></html>",
      "shared_with_children": false,
      "tags": "",
      "block_editor_type": "",
      "block_editor_content": null
    }
  }
}