Skip to main content

SMS Template

An SMS template is a predefined message format that can be used repeatedly without needing to rewrite it each time.​

Create Template​

This endpoint allows you to create a bucket which contains all the phone numbers to be reached via sms.

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

This API creates SMS Bucket

Parameters

Body

name*

String

Name of Template

description*

String

Description of template

message*

String

Actual template form to be used continuously

Sample Request​

{
    "name": "First template",
    "description": "Used for new user onboarding",
    "message": "Welcome to our platform!"
}

Responses

200:OK
Success
{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "uuid": "5b9840d0-2382-4289-a4da-d7ecf3270d98",
        "merchant_id": "AABBCCDDEEFFGGHHJJKK",
        "name": "First template",
        "description": "Used for new user onboarding",
        "pages": 1,
        "message": "Welcome to our platform!",
        "createdAt": "2025-05-22T10:08:03.733Z",
        "updatedAt": "2025-05-22T10:08:03.733Z"
    }
}

Get All Created Template​

This endpoint allows you to retrieve all created templates

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

This API retrieves all Template

Parameters

Body

page

Integer

Page number

perPage

Integer

Number of rows per page

sorted_by

String

Sorting by creation date

dir

String

DSC/ASC

date_from

date

Beginning date

date_to

date

Ending date

Responses

200:OK
Success
{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "count": 1,
        "rows": [
            {
                "uuid": "a3795ac3-8252-4ce0-aa6c-def776570455",
                "merchant_id": "EAZMC2DZ",
                "name": "Test_002",
                "description": "Test template",
                "pages": 1,
                "message": "Hi, Get a life",
                "createdAt": "2025-05-16T14:19:44.380Z",
                "updatedAt": "2025-05-16T14:19:44.380Z"
            }
        ]
    }
    }

Update Created Template​

This endpoint enables you to modify the content of a template.

PATCH
https://sandbox-api-d.squadco.com/sms/template/:id

This API update template

Sample Request​

{
  {
  "name": "file123",
  "description": "baa baa black sheep",
  "file_name": "test.csv"
}
}

Responses

200:OK
Success
{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "uuid": "edb720f0-6162-46f2-aafe-c52962bd56f8",
        "merchant_id": "EAZMC2DZ",
        "name": "Updated Template",
        "description": "Updated description here",
        "pages": 1,
        "message": "This is an updated message.",
        "createdAt": "2025-05-22T09:11:48.562Z",
        "updatedAt": "2025-05-22T09:13:40.273Z"
    }
}

DELETE CREATED BUCKETS​

This endpoint enables you to delete a template.

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

This API deletes created Template

Parameters

Path

id*

String

The uuid of the bucket to be deleted

Responses

200:OK
Success
{
    "message": "success"
}