Browse and Modify Account Information
You can browse and modify your account information via the Textmagic SMS API. This page will explain how to do that.
Get current account information
To get account information, use:
GET /api/v2/user
Note, this command has no parameters.
You will receive a response in the following format:
|
Parameter
|
Example
|
Description
|
|---|---|---|
| id | 305 |
User ID. |
| username | charles.conway |
Username. |
[email protected] |
User email address. | |
| status |
|
Current account status:
|
| balance | 208.64 |
Account balance (in account currency). |
| currency | currency | See currency codes below. |
| firstName | Charles |
Account first name. |
| lastName | Conway |
Account last name. |
| company | Example Ltd. |
Account company name. |
| subaccountType | A |
Type of account:
|
| timezone | timezone | See timezone codes below. |
Currency resource format
The currency records show the account currency and contain the following fields:
|
Parameter
|
Example
|
Description
|
|---|---|---|
| id |
|
Three-letter ISO currency ID. |
| htmlSymbol |
£$
|
HTML-compatible currency symbol. |
Timezone resource format
The timezone resource represents the account timezone:
|
Parameter
|
Example
|
Description
|
|---|---|---|
| id |
185 |
Internal timezone ID. |
| area |
Asia Europe |
Timezone area. |
| dst | 1 | Is Daylight saving time used in this timezone? |
| offset | 21600 | Offset from UTC time in seconds. In this example it is 21600/60/60=6 hours. |
| timezone | Europe/London | User-friendly timezone name (with spaces replaced by underscores). |
Edit current account info
To modify account information use PUT:
PUT /api/v2/user
with the following parameters:
|
Name
|
Required?
|
Example
|
Description
|
|---|---|---|---|
| firstName | Yes |
|
Account first name. |
| lastName | Yes | Conway |
Account last name. |
| company | Yes | Example Ltd. |
Account company name. |
If errors are made during the request, the standard error response will be returned.
The next step
Now you’ve learned how to view and edit account information via the Textmagic API, to learn how to manage Sub-accounts, please continue to the next section.
