SenderIds

Marsol API provides robust functionality for managing Sender IDs. A Sender ID is a unique identifier used to indicate the sender of an SMS message. This feature is particularly useful for branding purposes, as it allows recipients to easily recognize the sender of the message.

---

get

Authorizations

x-auth-token

x-auth-tokenstringRequired

Responses

200Success

application/json

idstringRead-onlyRequired

namestringRead-onlyRequired

privatebooleanRead-onlyRequired

createdAtstring · date-timeRead-onlyRequired

availablebooleanRead-onlyRequired

operationPreferencenumberRead-onlyRequired

carrierPreferencestring[]Read-onlyRequired

isDefaultbooleanRead-onlyRequired

get

/public/senderIds

HTTPcURLJavaScriptPython

GET /public/senderIds HTTP/1.1
Host: api.marsol.ly
x-auth-token: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "name": "text",
    "private": true,
    "createdAt": "2026-03-25T20:01:18.452Z",
    "available": true,
    "operationPreference": 1,
    "carrierPreference": [
      "text"
    ],
    "isDefault": true
  }
]

Endpoint: /public/senderIds

Method: GET

This endpoint retrieves a list of all sender IDs available to the user.

Request Parameters: None

GET /public/senderIds HTTP/1.1
Host: api.marsol.ly
x-auth-token: your_api_token_here
Content-Type: application/json

Security: Requires authentication token (x-auth-token).

Response:

• id (string): The uniqeu identifier of the sender.

• name (string): The name of the sender.

• private (boolean): Indicates if the sender is available for public use or available for specific accounts.

• createdAt (string, date-time): The timestamp when the sender was created.

• available (boolean): Indicates if the sender is available or out of service.

• operationPreference (number): Refers to the types of operations a virtual number supports, which can be: 2 for SMS, 4 for flash calls, and 8 for voice messages. Note: A combination of these values indicates support for multiple operations. For example, 6 (2 + 4) means the virtual number supportsSMS and flash call, while 14 (2 + 4 + 8) means SMS, flash call, and voice call are all supported.

• carrierPreference (array, array of strings): The supported networks of which the sender will be communicating with (LIBYANA, ALMADAR, null) with null indicating that it can communicate with both.

• isDefault (boolean): Indicates if the sender is the default sender for the account.

[
  {
    "id": "string",
    "name": "string",
    "private": true,
    "createdAt": "2024-08-12T12:11:46.222Z",
    "available": true,
    "operationPreference": 0,
    "carrierPreference": [
      "string"
    ],
    "isDefault": true
  }
]

---

get

Authorizations

x-auth-token

x-auth-tokenstringRequired

Path parameters

senderIdstringRequired

Responses

200Success

application/json

idstringRead-onlyRequired

namestringRead-onlyRequired

privatebooleanRead-onlyRequired

createdAtstring · date-timeRead-onlyRequired

availablebooleanRead-onlyRequired

operationPreferencenumberRead-onlyRequired

carrierPreferencestring[]Read-onlyRequired

isDefaultbooleanRead-onlyRequired

get

/public/senderId/{senderId}

HTTPcURLJavaScriptPython

GET /public/senderId/{senderId} HTTP/1.1
Host: api.marsol.ly
x-auth-token: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "name": "text",
  "private": true,
  "createdAt": "2026-03-25T20:01:18.452Z",
  "available": true,
  "operationPreference": 1,
  "carrierPreference": [
    "text"
  ],
  "isDefault": true
}

Endpoint: /public/senderId/{senderId}

Method: GET

This endpoint retrieves the details of a specific sender ID.

Request Parameters:

• senderId (string, path): The unique identifier of the sender ID to retrieve.

Security: Requires authentication token (x-auth-token).

HTTP Request:

GET /public/senderId/{senderId} HTTP/1.1
Host: api.marsol.ly
x-auth-token: your_api_token_here
Content-Type: application/json

Response: The response will include the details of the sender ID, including:

• id (string): The uniqeu identifier of the sender.

• name (string): The name of the sender.

• private (boolean): Indicates if the sender is available for public use or available for specific accounts.

• createdAt (string, date-time): The timestamp when the sender was created.

• available (boolean): Indicates if the sender is available or out of service.

• operationPreference (number): Refers to the types of operations a virtual number supports, which can be: 2 for SMS, 4 for flash calls, and 8 for voice messages. Note: A combination of these values indicates support for multiple operations. For example, 6 (2 + 4) means the virtual number supportsSMS and flash call, while 14 (2 + 4 + 8) means SMS, flash call, and voice call are all supported.

• carrierPreference (array, array of strings): The supported networks of which the sender will be communicating with (LIBYANA, ALMADAR, null) with null indicating that it can communicate with both.

• isDefault (boolean): Indicates if the sender is the default sender for the account.

{
  "id": "string",
  "name": "string",
  "private": true,
  "createdAt": "2024-08-08T11:57:26.365Z",
  "available": true,
  "operationPreference": 0,
  "carrierPreference": [
    "string"
  ],
  "isDefault": true
}

---

put

Authorizations

x-auth-token

x-auth-tokenstringRequired

Path parameters

senderIdstringRequired

Responses

201Success

application/json

put

/public/senderId/{senderId}

HTTPcURLJavaScriptPython

PUT /public/senderId/{senderId} HTTP/1.1
Host: api.marsol.ly
x-auth-token: YOUR_API_KEY
Accept: */*

201Success

{
  "id": "text",
  "name": "text",
  "private": true,
  "createdAt": "2026-03-25T20:01:18.452Z",
  "available": true,
  "operationPreference": 1,
  "carrierPreference": [
    "text"
  ],
  "isDefault": true
}

Endpoint: /public/senderId/{senderId}

Method: PUT

This endpoint sets a specific sender ID as the default sender ID.

Request Parameters:

• senderId (string, path): The unique identifier of the sender ID to set as default.

Security: Requires authentication token (x-auth-token).

HTTP Request:

PUT /public/senderId/{senderId} HTTP/1.1
Host: api.marsol.ly
x-auth-token: your_api_token_here
Content-Type: application/json

Response: The response will include the details of the updated sender ID.

• id (string): The uniqeu identifier of the sender.

• name (string): The name of the sender.

• private (boolean): Indicates if the sender is available for public use or available for specific accounts.

• createdAt (string, date-time): The timestamp when the sender was created.

• available (boolean): Indicates if the sender is available or out of service.

• operationPreference (number): Refers to the types of operations a virtual number supports, which can be: 2 for SMS, 4 for flash calls, and 8 for voice messages. Note: A combination of these values indicates support for multiple operations. For example, 6 (2 + 4) means the virtual number supportsSMS and flash call, while 14 (2 + 4 + 8) means SMS, flash call, and voice call are all supported.

• carrierPreference (array, array of strings): The supported networks of which the sender will be communicating with (LIBYANA, ALMADAR, null) with null indicating that it can communicate with both.

• isDefault (boolean): Indicates if the sender is the default sender for the account.

{
  "id": "string",
  "name": "string",
  "private": true,
  "createdAt": "2024-08-08T11:59:49.092Z",
  "available": true,
  "operationPreference": 0,
  "carrierPreference": [
    "string"
  ],
  "isDefault": true
}