Manage sender name

Headers

All requests in this section will have the same headers.

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

Sender name details

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

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

Path Parameters

Name	Type	Description
id*	String	ID that you received after a successful request

Query Parameters

Name	Type	Description
sort_by	String	Optional. Sorting order for results. Possible values: asc (ascending) or desc (default).
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

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

Update sender settings

Important requirements! This API requires you to use an API Key from the Default organization (the first organization in your account)

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

Request body

Name	Type	Description
organization_id	String	ID of the new organization for this sender name.

Response

200: Accepted

Response will be the same as in the GET method, but with updated values.

400: Bad Request

Cancel sender name

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

The sender's name is canceled immediately. Please check the cancellation policy in Helpdesk before using this method.

Response

200: Accepted

{
    "success": true,
}

400: Bad Request