Edits an existing client on your account. Send a POST request to https://api.transmitsms.com/edit-client.json with the parameters below. Only send the parameters you want to change.

 

Parameter	Description	Required
client_id	The ID of the client	YES
name	Client company name	NO
contact	Contact name	NO
email	Client email address	NO
password	Client password	NO
msisdn	Client phone number, internationally formatted (e.g. AU 61491570156, UK 447500017696)	NO
timezone	A valid TZ zone name, e.g. Australia/Sydney. Defaults to your own.	NO
client_pays	Boolean. true if the client pays, false if you pay. When false, margins and top-up settings are reset to zero.	NO
sms_margin	Amount added to the base SMS price, in minor currency units (cents, pence). A decimal value, credited to you.	NO
number_margin	Amount added to the base virtual number lease price, in minor currency units. A decimal value.	NO
payment_method	fixed or variable. With fixed, every top-up is processed at the fixed_top_up_amount and the client cannot change it. A client already on a fixed amount cannot be moved back to variable through this endpoint. The request succeeds but the setting is unchanged. Contact support to switch a client back.	NO
fixed_top_up_amount	The set top-up amount for the client. Required when payment_method is fixed, ignored otherwise. Rounded to whole units and capped at your account's default top-up maximum.	NO
auto_recharge_amount	Amount added automatically when the client's balance runs out, charged to their stored card. Set to 0 to disable. Requires client_pays to be true.	NO
longcode	Existing virtual number to assign to the client.	NO
longcode_lease_price	Lease charge for the virtual number.	NO
longcode_exclusive	yes or no. Controls exclusive access to the number.	NO

 Notes

• Parameters you omit keep their current values.
• email cannot be changed through this endpoint.
• A client on a fixed payment method cannot be switched back to variable through this endpoint. Contact support to switch a client back.
• All amounts are in your account's currency.
• Auto recharge stays inactive until the client adds a payment card in Billing Settings.
• On a fixed payment method, auto recharge always uses the fixed_top_up_amount.
• get-client returns the fixed amount as both fixed_top_up_amount and recharge_amount, and the auto recharge setting as auto_recharge_amount.

Example

 

JSON Response

 

XML Response

 

PHP Example