Skip to content

Campaign — SMS

Campaign SMS entity. This is the payload sent via SMS when the campaign runs.

Note

The SMS sender ID is configured at the platform level and cannot be set per campaign. Contact your account manager to change the registered sender ID.

Endpoint

Method URL
POST /campaign/<campaign>/sms
PUT /campaign/<campaign>/sms
DELETE /campaign/<campaign>/sms

POST /campaign/<campaign>/sms

Parameter Type Description
message string Message text

Returns: The edited campaign and SMS.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "message=Your+SMS+message+here" \
  https://app.duo.pt/campaign/{campaign_id}/sms

Response:

{
  "success": true,
  "data": {
    "sms": {
      "message": "Your order has been confirmed.",
      "send_scheduled": 1
    }
  }
}

PUT /campaign/<campaign>/sms

Parameter Type Description
message string Message text

Note

Parameters must be sent as query string (not request body), and must include send_scheduled set to the campaign ID.

Returns: The edited campaign and SMS.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X PUT \
  "https://app.duo.pt/campaign/{campaign_id}/sms?send_scheduled={campaign_id}&message=Updated+SMS+text"

Response:

{
  "success": true,
  "data": {
    "sms": {
      "message": "Updated SMS text",
      "send_scheduled": 1
    }
  }
}

DELETE /campaign/<campaign>/sms

Payload: No payload.

Returns: The deleted SMS.

Example:

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

Response:

{
  "success": true,
  "data": {
    "sms": {
      "message": "Your order has been confirmed.",
      "send_scheduled": 1
    }
  }
}