Unsubscribe Endpoint

Along with a subscribe endpoint, WP SMS provides a REST API endpoint that allows you to unsubscribe users from your SMS newsletter programmatically.

The Endpoint

POST  https://site.com/wp-json/wpsms/v1/newsletter/unsubscribe

Replace site.com with your actual website URL.

Request

<?php
// Your WordPress username (with wpsms_subscribers capability) and Application Password
$username = 'your-username';
$password = 'your-application-password';

// Encode credentials for Basic Authentication
$auth = base64_encode("$username:$password");

// Subscriber's information
$postData = array(
    'name'     => 'User Name',
    'mobile'   => '912345678',
    'group_id' => '5', // Optional, remove if not needed
);

// The endpoint URL
$url = 'https://site.com/wp-json/wpsms/v1/newsletter/unsubscribe';

// Set up the arguments for wp_remote_post
$args = array(
    'headers' => array(
        'Authorization' => 'Basic ' . $auth,
        'Content-Type'  => 'application/x-www-form-urlencoded',
    ),
    'body' => $postData,
);

// Make the request
$response = wp_remote_post($url, $args);

// Check for errors
if (is_wp_error($response)) {
    $error_message = $response->get_error_message();
    echo "Error: $error_message";
} else {
    // Get the response body
    $body = wp_remote_retrieve_body($response);
    echo "Response: $body";
}

Response

{
  "message": "Your mobile number has been successfully unsubscribed.",
  "error": [],
  "data": []
}