Ir para o conteúdo

Transacional

Objeto de configuração de envio transacional. Contém definições para email de baixo volume: - Email enviado em reacção a webhooks - Email enviado via gateway SMTP - Email enviado via automação de email

Endpoints

Método URL
GET /transactional/<transactional>
POST /transactional
PUT /transactional/<transactional>
DELETE /transactional/<transactional>

GET /transactional/<transactional>

Payload: Sem payload.

Devolve: O objeto transacional.

Example:

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

Response:

{
  "success": true,
  "data": {
    "transactional": {
      "id": 1,
      "owner": 1,
      "name": "Order Confirmation",
      "list": 1,
      "domain": 1,
      "smtp_submission": false,
      "send_dsn": false
    },
    "page": 1,
    "messagesPageCount": 0,
    "messages": [],
    "automationsPageCount": 0,
    "automations": []
  }
}

POST /transactional

Parâmetro Tipo Descrição
name string Nome do objeto transacional
list int ID da lista de contactos para os contactos de destino
domain int ID do domínio de bounce
smtp_submission boolean Utilizar este objeto para o gateway SMTP. Apenas um por utilizador.
send_dsn boolean Reencaminhar notificações de estado de entrega para o remetente original

Devolve: O objeto transacional criado.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "name=My+Transactional&list={{list_id}}&domain={{domain_id}}&smtp_submission=false&send_dsn=false" \
  https://app.duo.pt/transactional

Response:

{
  "success": true,
  "data": {
    "transactional": {
      "id": 1,
      "owner": 1,
      "name": "Order Confirmation",
      "list": 1,
      "domain": 1,
      "smtp_submission": false,
      "send_dsn": false
    }
  }
}

PUT /transactional/<transactional>

Mesmo payload que o POST.

Devolve: O objeto transacional editado.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X PUT \
  -d "name=Updated&list={{list_id}}&domain={{domain_id}}&smtp_submission=false&send_dsn=false" \
  https://app.duo.pt/transactional/{transactional_id}

Response:

{
  "success": true,
  "data": {
    "transactional": {
      "id": 1,
      "owner": 1,
      "name": "Order Confirmation",
      "list": 1,
      "domain": 1,
      "smtp_submission": false,
      "send_dsn": false
    }
  }
}

DELETE /transactional/<transactional>

Payload: Sem payload.

Devolve: O objeto transacional eliminado.

Example:

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

Response:

{
  "success": true,
  "data": {
    "transactional": {
      "id": 1,
      "owner": 1,
      "name": "Order Confirmation",
      "list": 1,
      "domain": 1,
      "smtp_submission": false,
      "send_dsn": false
    }
  }
}