CAMPAIGNS

This set of endpoints allows you send messages and campaigns.

SEND INSTANT SMS

This endpoint allows you to curate and send sms instantly.

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

Request Body

Name	Type	Description
sender_id*	String	Unique merchant sender id
messages	object	Contains two parameters; phone_number message

Sample Request

{
  "sender_id": "S-Alert",
  "messages": [
    {
      "phone_number": "08064834084",
      "message": "Hello there"
    }
  ]
}

Success Response

{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "success": true,
        "message": "submitted successfully",
        "data": {
            "batch_id": "20250522081746187_541_EAZMC2DZ_SQUADSMS_NGN",
            "sent": [
                {
                    "phone_number": "08064834084",
                    "status": "SENT",
                    "cost": 5.41,
                    "transaction_id": "20250522081746187_541_EAZMC2DZ_SQUADSMS_NGN_000"
                }
            ],
            "errors": [],
            "total_cost": 5.41,
            "currency": "NGN"
        }
    }
}

Error Response

CREATE CAMPAIGN

This endpoint allows you to create campaigns

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

Sample Request

{
    "name": "Promo Campaign",
    "bucket_id": "3d27d03c-e14d-494f-822e-106946898daf",
    "sender_id": "S-Alert",
    "is_scheduled": true,
    "scheduled_for": "2025-06-01T10:00:00Z",
    "template_id": "cdbbc03e-1e0b-4c20-aacd-04eb11e702c2"
}

Sample Response

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

FIND ALL CAMPAIGNS

This endpoint allows you to retrieve all campaigns

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

Query Params	Type	Description
perPage	Integer	number of templates to view per page
page	Integer	number of pages to view
sort_by	String	Sorted by creation date
status	String	pending, failed or success
name	String	name of campaign
dir	String	DSC/ASC
date_from	date	beginning date
date_to	date	ending

Delete Campaigns

DELETEhttps://sandbox-api-d.squadco.com/sms/bucket/{{:id}}

id is a String