Skip to content

Transactional — Message

A transactional message is a prepared, parameterizable message sent to a single contact.

Messages may use standard merge codes, plus Transactional:[argument_name] codes where argument_name is a freeform single word fed from arguments passed to /transactional/message/send/.

Endpoints

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

GET /transactional/<transactional>/message/<transactionalmessage>

Payload: No payload.

Returns: The message.

Example:

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

Response:

{
  "success": true,
  "data": {
    "transactionalMessage": {
      "id": 1,
      "name": "Order Confirmation",
      "send_transactional": 1,
      "event_callback": null
    },
    "transactional": {
      "id": 1,
      "owner": 1,
      "name": "Order Confirmation",
      "list": 1,
      "domain": 1,
      "smtp_submission": false,
      "send_dsn": false
    },
    "email": null,
    "sms": null
  }
}

POST /transactional/<transactional>/message

Parameter Type Description
name string Message name
event_callback string Optional. URL called back when events occur.

Returns: The new message.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "name=My+Message" \
  https://app.duo.pt/transactional/{transactional_id}/message

Response:

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

PUT /transactional/<transactional>/message/<transactionalmessage>

Same payload as POST.

Returns: The edited message.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X PUT \
  -d "name=Updated+Message" \
  https://app.duo.pt/transactional/{transactional_id}/message/{message_id}

Response:

{
  "success": true,
  "data": {
    "transactionalMessage": {
      "id": 1,
      "name": "Order Confirmation",
      "send_transactional": 1,
      "event_callback": null
    }
  }
}

DELETE /transactional/<transactional>/message/<transactionalmessage>

Payload: No payload.

Returns: The deleted message.

Example:

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

Callback Behaviour

Same callback behaviour as Campaign.