Get specific Opt-out
Base URL:
GET: https://api.smsgatewayapi.com/v1/optouts/{ID}Example:
GET: https://api.smsgatewayapi.com/v1/optouts/115113
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Login and go to 'Developer' - 'API & Webhooks' - 'API-credentials' to find the API keys | Required |
| client_secret | API client secret | Login and go to 'Developer' - 'API & Webhooks' - 'API-credentials' to find the API keys | Required |
| ID | Opt-out ID | The ID of the opt-out. Both the numeric ID and the public ID (opt_...) are accepted | Required |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/optouts/{ID}";
$client_id = "XXX"; // Your API client ID (required)
$client_secret = "YYY"; // Your API client secret (required)
curl_setopt($ch, CURLOPT_URL, "$url");
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_VERBOSE, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"X-Client-Id: $client_id",
"X-Client-Secret: $client_secret",
"Content-Type: application/json",
]);
$response = curl_exec($ch);
?>
Example success response:
{
"ID": {ID},
"public_ID": "opt_c6dab1d038504ac910f1254f20383622",
"number": "{nr}",
"memo": null,
"date": "2026-08-01"
}
Invalid response:
Response when ID doesn’t exist: http status code 404 (Not Found).
