Pools

List

Use this method to get a list of all sender pool related to a specific organization

GET https://a.loopmessage.com/api/v1/pool/list/

Headers

Name	Type	Description
Authorization*	String	API Key. Required*.
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
sort_by	String	Optional. Sorting order for results. Possible values: asc or desc.
page	Integer	Optional. The page number to retrieve. Default is 1.
per_page	Integer	Optional. Number of webhook records per page. Default is 20.

Response

{
  "page": 1,
  "num_pages": 1,
  "per_page": 20,
  "count": 1,
  "items": [
    {
      "id": "string",
      "name": "string",
      "count": 1,
      "create_date": "2025-01-27T22:23:51Z"
    }
  ]
}

Manage pool

Headers

All requests in this section will have the same headers.

Name	Type	Description
Authorization*	String	API Key. Required*.
Content-Type*	String	application/json

Pool details

Use this method to get a list of sender names related to a specific organization

GET https://a.loopmessage.com/api/v1/pool/{id}/

Path Parameters

Name	Type	Description
id*	String	Sender pool ID

Response

{
    "id": "string",
    "name": "string",
    "status": "enum string",
    "create_date": "2025-01-27T22:23:51Z",
}

Update pool

PATCH https://a.loopmessage.com/api/v1/sender/{id}/

Request body

Name	Type	Description
name	String	Optional. New name for the pool.
ids	Array	Optional. Array with sender name IDs.

JSON Example

{
  "name": "pool1",
  "ids": ["id1", "id2", "id3"]
}

Response

Response {.tabset .tabset-fade}

tab 200: Accepted

{
    "success": true,
}

tab 400: Bad Request

{
    "code": 100,
    "success": false,
    "message": "error description",
}

Delete pool

DELETE https://a.loopmessage.com/api/v1/sender/{id}/

Response

Response {.tabset .tabset-fade}

tab 200: Accepted

{
    "success": true,
}

tab 400: Bad Request

{
    "code": 100,
    "success": false,
    "message": "error description",
}

New pool

Use this method to create a new pool of sender names.

POST https://a.loopmessage.com/api/v1/pool/new/

Request body

Name	Type	Description
name	String	Optional. New name for the pool.
ids	Array	Optional. Array with sender name IDs.

JSON Example

{
  "name": "new pool",
  "ids": ["id1", "id2", "id3"]
}

Response

Response {.tabset .tabset-fade}

tab 200: Accepted

{
    "id": "string",
    "name": "string",
    "count": 1,
    "create_date": "2025-01-27T22:23:51Z"
}

tab 400: Bad Request

{
    "code": 100,
    "success": false,
    "message": "error description",
}