BUCKET

A bucket is a collection of phone numbers that can be uploaded, organized into an excel format

This documentation site has been deprecated as of September 8, 2025, and will no longer receive updates. Please refer to the new documentation site at https://docs.squadco.com.

CREATE BUCKET

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

POST https://squadbygtco.com:8080/dashboard/bucket

Request Body

Name	Type	Description
name*	String	Name of the bucket
description*	String	Description of bucket
Client_id*	Integer	Unique Client ID pre-assigned
items*	Object	Phone number and detail of each

Sample Request

{
  "name": "nov2022",
    "description": "November birthdays",
    "client_id": 1,
    "items": [
        {
            "phone_number": "0701234",
            "param1": "012"
        },
        {
            "phone_number": "0701234",
            "param1": "012"
        }
    ]

}

Success Response

{
    "status": "CREATED",
    "message": "bucket created successfully",
    "data": {
        "id": 2,
        "name": "nov2022",
        "description": "november birthdays",
        "params": [
            "phone_number",
            "param1"
        ],
        "client_id": 1,
        "created_at": "2024-04-08T11:55:08.000Z",
        "created_by": 1,
        "updated_at": null,
        "updated_by": null,
        "bucket_items": 2
    }
}

Error Response

GET ALL CREATED BUCKETS

This endpoint allows you to retrieve created buckets

GET https://squadbygtco.com:8080/dashboard/bucket/by-client/1?page=1&count=10

Success Response

{
    "message": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "nov2022",
                "description": "november birthdays",
                "params": [
                    "phone_number",
                    "param1"
                ],
                "client_id": 1,
                "created_at": "2024-02-29T11:22:51.000Z",
                "created_by": 8,
                "updated_at": null,
                "updated_by": null
            },
            {
                "id": 2,
                "name": "nov2022",
                "description": "november birthdays",
                "params": [
                    "phone_number",
                    "param1"
                ],
                "client_id": 1,
                "created_at": "2024-04-08T11:55:08.000Z",
                "created_by": 1,
                "updated_at": null,
                "updated_by": null
            }
        ],
        "total": 2
    }
}

Error Response

UPDATE CREATED BUCKETS

This endpoint allows you to edit details for already created buckets. It allows editing the name of the bucket

PATCH https://squadbygtco.com:8080/dashboard/bucket/1

Sample Request

{
  "name":"nov2023_bucket"
}

Sample Response

{
    "message": "success",
    "data": {
        "id": 1,
        "name": "nov2023_bucket",
        "description": "november birthdays",
        "params": [
            "phone_number",
            "param1"
        ],
        "client_id": 1,
        "created_at": "2024-02-29T11:22:51.000Z",
        "created_by": 8,
        "updated_at": "2024-04-08T12:47:21.000Z",
        "updated_by": 1
    }
}

Error Response

DELETE CREATED BUCKETS

This endpoint allows you to delete a bucket

DELETE https://squadbygtco.com:8080/dashboard/bucket/1

Sample Response

{
    "message": "success"
}