Skip to main content

Messages

This set of endpoints allows you send messages, campaigns, statistics and status.

Send Message​

This endpoint allows you to curate and send messages.

POST
https://sandbox-api-d.squadco.com/sms/send/instant

This API create and send Messages

Parameters

Body

sender_id*

String

Unique merchant sender id

message

String

Contains two parameters; phone_number message

Sample Request​

{
  "sender_id": "S-Alert",
  "messages": [
    {
      "phone_number": "08064834011",
      "message": "Hello there"
    }
  ]
}
{
  "status": 200,
  "success": true,
  "message": "Success",
  "data": {
      "success": true,
      "message": "submitted successfully",
      "data": {
          "batch_id": "20250522081746187_541_EAZMC2DZ_SQUADSMS_NGN",
          "sent": [
              {
                  "phone_number": "08064834011",
                  "status": "SENT",
                  "cost": 5.41,
                  "transaction_id": "20250522081746187_541_EAZMC2DZ_SQUADSMS_NGN_000"
              }
          ],
          "errors": [],
          "total_cost": 5.41,
          "currency": "NGN"
      }
  }
}

Create Campaign​

This endpoint allows you to create campaigns

POST
https://sandbox-api-d.squadco.com/sms/campaign

This API create a message campaign

Parameters

Body

name*

String

Name of the campaign to be created

bucket_id*

String

The uuid of the bucket to be used for the campaign

sender_id*

String

Unique merchant sender id

is_scheduled*

Boolean

Boolean status to indicate if the campaign is a scheduled campaign or not

sscheduled_dor*

String

Unique merchant sender id

template_id*

String

Message template to be used for the campaign

Responses

200:OK
Success
{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "uuid": "4c054f71-790f-4cab-9530-2b18ba243c27",
        "name": "Dianne Spencer",
        "cost": "0.00",
        "scheduled_for": "Wed Dec 31 2025 10:05:10 GMT+0100 (West Africa Standard Time)",
        "status": "pending",
        "merchant_id": "EAZMC2DZ",
        "createdAt": "2025-02-18T14:02:27.403Z",
        "updatedAt": "2025-02-18T14:02:27.418Z",
        "bucket_id": "3d27d03c-e14d-494f-822e-106946898daf",
        "sender_id": "S-Alert",
        "template_id": "cdbbc03e-1e0b-4c20-aacd-04eb11e702c2"
    }
}

Get All Campaign​

This endpoint allows you to retrieve all campaigns

GET
https://sandbox-api-d.squadco.com/sms/campaign

This API retrieves all Campaigns

Parameters

Query Params

page

Integer

Page number

perPage

Integer

Number of rows per page

sorted_by

String

Sorting by creation date

status

String

pending, failed or success

name

String

Name of the campaign

dir

String

DSC/ASC

date_from

date

Beginning date

date_to

date

Ending date

Responses

200:OK
Success
{
        "status": "SUCCESS",
        "message": "campaigns retrieved successfully",
        "data": {
            "items": [
                {
                    "id": 1,
                    "name": "abc_123",
                    "client_id": 1,
                    "template_id": 1,
                    "bucket_id": 1,
                    "total": 2,
                    "created_at": "2024-02-29T11:27:13.000Z",
                    "created_by": null
                }
            ],
            "total": 1
        }
}

Delete Campaign​

This endpoint enables you to delete a campaign.

POST
https://sandbox-api-d.squadco.com/sms/campaign/{{:id}}

This API deletes created Campaign

Parameters

Path

id*

String

The uuid of the campaign to be deleted