Update a user
Put /users/{id}
URL parameters:
| Name | Description | Type | Mandatory |
|---|---|---|---|
| id | User Id | String | Yes |
Parameters:
| Name | Description | Type | Mandatory |
|---|---|---|---|
| username | Email address / Login of the user | String | No |
| firstName | First Name | String | No |
| lastName | Last Name | String | No |
Response:
| Name | Description | Type |
|---|---|---|
| status | success / failure | String |
Programming language:
Request exemple:
{
"username": "email1@example.com",
"firstName": "Firstname",
"lastName": "Lastname"
}
Response exemple:
{
"status": "success"
}
Code example:
curl -X PUT -d '{"firstName":"New First Name", "lastName":"New Last Name"}' -H "Content-Type: application/json" -H "X-Tipimail-apiUser:YOUR_SMTP_USERNAME" -H "X-Tipimail-ApiKey:YOUR_SMTP_KEY" https://api.tipimail.com/v1/users/f4re5f5re4gre7gre8g87g58
require 'vendor/autoload.php';
$tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY');
try {
$tipimail->getUsersService()->updateUsername('646r54g6r4gr6g46g46546d4', 'mail@example.com');
$tipimail->getUsersService()->updateFirstName('646r54g6r4gr6g46g46546d4', 'Firstname');
$tipimail->getUsersService()->updateLastName('646r54g6r4gr6g46g46546d4', 'Lastname');
}
catch(Tipimail\Exceptions\TipimailException $e) {
echo 'Exception received :', $e->getMessage(), "\n";
}