Textlocal Logo

API Documentation

Update User

A Reseller only service Requires Advanced Reseller API This command can be used to update a sub account under a dual brand or white label provider account.

Resource URL

https://api.textlocal.in/update_user/

Sample Request

<?php

$data = [
    'apiKey' => 'Your API Key',
    'name' => 'Jane Doe',
];

// Send the POST request with cURL
$ch = curl_init('https://api.textlocal.in/update_user/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

// Process your response here
echo $response;
<?php

$data = [
    'apiKey' => 'Your API Key',
    'name' => 'Jane Doe',
];

$data = http_build_query($data);

// Send the GET request with cURL
$ch = curl_init('https://api.textlocal.in/update_user/?' . $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

// Process your response here
echo $response;

Parameters

user_id ID of the user you wish to edit. Found in get_users
Login Parameters (Additional Information)
apiKey You can create these in your Messenger Control Panel (click here) for each application, and limit the usage of them by host IP Address.
Optional Parameters
name The full name of the user account to add. E.g. "John Doe".
user_email The email address of the user account. If updating the user_email, a new password must also be provided with user_password
user_password The password the user will use to login with in conjunction with their email address. Must be between 6 and 20 characters inclusive.
sender The default sender name used for messages sent. Must be between 3 and 11 alphanumeric characters inclusive.
address The first lines postal address of the customer. E.g. "Company, Unit 35, Business Park, Long Road".
postcode The user's postcode.
town The user's town.
county The user's county.
telephone The user's telephone number.
company The user's company.

Sample Response

{
	"status": "success"
}
<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <status>
    success
  </status>
</response>

Errors

Error Codes
172 No reseller account found
311 This endpoint requires the advanced reseller API.
67 Invalid email address.
69 Invalid user ID specified.
43 Invalid sender name.
304 Invalid password.
305 There is already an account with that email address.
310 Sub account email cannot be changed without also changing the password.