Phone numbers soon

Get information about SMS phone numbers.

Get a list of SMS phone numbers

Get a list of SMS phone numbers information with this GET request:

GET  https://api.mailersend.com/v1/sms-numbers
1

Request parameters

JSON parameters are provided in dot notation

URL parameterTypeRequiredLimitationsDetails
pausedboolno
pageintno
limitintnoMin: 10, Max: 100Default: 25

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": [
    {
      "id": "7z3m5jgrogdpyo6n",
      "telephone_number": "+1234567890",
      "paused": false,
      "created_at": "2022-01-01T12:00:00.000000Z"
    },
    ...
  ]
}
1
2
3
4
5
6
7
8
9
10
11

Error

Response Code: 422 Unprocessable Entity
1

See - Validations errors

Get an SMS phone number

Get information about a specific SMS phone number with this GET request:

GET https://api.mailersend.com/v1/sms-numbers/{sms_number_id}
1

Request parameters

JSON parameterTypeRequiredLimitationsDetails
sms_number_idstringyes

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": {
    "id": "7z3m5jgrogdpyo6n",
    "telephone_number": "+1234567890",
    "paused": false,
    "created_at": "2022-01-01T12:00:00.000000Z"
  }
}
1
2
3
4
5
6
7
8

Error

Response Code: 404 Not Found
1

Update a single SMS phone number

Update a specific SMS phone number with this PUT request:

PUT https://api.mailersend.com/v1/sms-numbers/{sms_number_id}
1

Request parameters

URL parameterTypeRequiredLimitationsDetails
sms_number_idstringyes
Query parameterTypeRequiredLimitationsDetails
pausedboolno

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": {
    "id": "7z3m5jgrogdpyo6n",
    "telephone_number": "+1234567890",
    "paused": true,
    "created_at": "2022-01-01T12:00:00.000000Z"
  }
}
1
2
3
4
5
6
7
8

Error

Response Code: 422 Unprocessable Entity
1

See - Validations errors

Delete an SMS phone number

Delete an SMS phone number with this DELETE request:

DELETE  https://api.mailersend.com/v1/sms-numbers/{sms_number_id}
1

Request parameters

URL parameterTypeRequiredLimitationsDetails
sms_number_idstringyes

Responses

Valid

Response Code: 204 OK
Response Body: [EMPTY]
1
2

Error

Response Code: 404 Not Found
1
Last Updated: