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

Updated 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

{
    "success": true,
}

Delete pool

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

Response

{
    "success": true,
}

Last updated