Recipients soon

Get information about SMS recipients.

Get a list of SMS recipients

Get a list of SMS recipients information with this GET request:

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

Request parameters

JSON parameters are provided in dot notation

URL parameterTypeRequiredLimitationsDetails
statusstringnoactive, opt_out
sms_number_idstringno
pageintno
limitintnoMin: 10, Max: 100Default: 25

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": [
    {
      "id": "62347d2be979fd275c0afd34",
      "number": "+1234567890",
      "status": "active",
      "created_at": "2022-01-01T12:00:0003.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 recipient

Get information about a specific SMS recipient with this GET request:

GET https://api.mailersend.com/v1/sms-recipients/{sms_recipient_id}
1

Request parameters

JSON parameterTypeRequiredLimitationsDetails
sms_recipient_idstringyes

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": {
    "id": "62347d2be979fd275c0afd34",
    "number": "+1234567890",
    "status": "active",
    "created_at": "2022-01-01T12:00:00.000000Z",
    "sms": [
      {
        "id": "62347d2be979fd275c0afd33",
        "from": "+1234567890",
        "to": "+1234567890",
        "text": "Lorem Ipsum is simply dummy text",
        "status": "delivered",
        "segment_count": 1,
        "error_type": null,
        "error_description": null,
        "created_at": "2022-01-01T12:00:00.000000Z"
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Error

Response Code: 404 Not Found
1

Update a single SMS recipient

Update a specific SMS recipient with this PUT request:

PUT https://api.mailersend.com/v1/sms-recipients/{sms_recipient_id}
1

Request parameters

URL parameterTypeRequiredLimitationsDetails
sms_recipient_idstringyes
Query parameterTypeRequiredLimitationsDetails
statusstringyesactive, opt_out

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": {
    "id": "62347d2be979fd275c0afd34",
    "number": "+1234567890",
    "status": "opt_out",
    "created_at": "2022-01-01T12:00:0003.000000Z"
  }
}
1
2
3
4
5
6
7
8

Error

Response Code: 422 Unprocessable Entity
1

See - Validations errors

Last Updated: