Skip to content

Transactional

Transactional send configuration object. Holds settings for low-volume email: - Email sent in reaction to webhooks - Email sent via SMTP gateway - Email sent via email automation

Endpoints

Method URL
GET /transactional/<transactional>
POST /transactional
PUT /transactional/<transactional>
DELETE /transactional/<transactional>

GET /transactional/<transactional>

Payload: No payload.

Returns: The transactional object.

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

Parameter Type Description
name string Transactional object name
list int ID of the contact list for destination contacts
domain int ID of the bounce domain
smtp_submission boolean Use this object for the SMTP gateway. Only one per user.
send_dsn boolean Back-propagate delivery status notifications to the original sender

Returns: The created transactional object.

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>

Same payload as POST.

Returns: The edited transactional object.

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: No payload.

Returns: The deleted transactional object.

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
    }
  }
}