PUT api/v1/admin/users/{id}
Updates user details of the specified user. The logged in user must have permission to perform this action.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The ID of the user to be modified. |
globally unique identifier |
Required |
Body Parameters
The new details of the user.
TwoSms.CustomerPortalRole.API.Admin.Users.UserName | Description | Type | Additional information |
---|---|---|---|
ID |
The unique identifier for the user. |
globally unique identifier |
None. |
AgreementDate |
The date the user accepted the privacy policy and data processing agreement. This field is read-only. |
date |
None. |
AccountID |
The unique identifier for the account. |
globally unique identifier |
None. |
AdminUser |
Determines if the user is an admin user. |
boolean |
None. |
DateCreated |
The date the user account was created. |
date |
None. |
DateModified |
The date the user account was last modified. |
date |
None. |
DeclineDate |
The date the user declined the privacy policy and data processing agreement. This field is read-only. |
date |
None. |
DisplayName |
The name of the user. |
string |
Required |
DPAVersion |
The version of the data processing agreement that the user has accepted. This field is only read-only. |
string |
None. |
EmailAddress |
The email address of the user. |
string |
Required Data type: EmailAddress |
Enabled | boolean |
Required |
|
LanguageID |
The Id of the language of the user. |
globally unique identifier |
Required |
MobilePhone |
The mobile phone of the user |
string |
Required Matching regular expression pattern: ^(?=.*?\d.*?\d.*?\d.*?\d.*?\d)([+]?)([\d\s\(\)-]{5,20})$ |
Password |
The password of the user. |
string |
None. |
Pin |
Sets the security pin when two factor has been enable. Set it to null if you want it to randonly generate each login. |
string |
None. |
Preferences | TwoSms.CustomerPortalRole.API.Admin.Users.Preferences |
None. |
|
PrivacyPolicyVersion |
The version of the privacy policy that the user has accepted. This field is only read-only. |
string |
None. |
TimeZone |
The timezone of the user. |
string |
Required |
Username |
The username of the user to log into the system. |
string |
Required |
Request Formats
application/json, text/json
{ "ID": "cae9abd8-15d9-4dda-a0a5-4b14ad6ae7f8", "AgreementDate": "2025-04-24T14:03:00.2663399+00:00", "AccountID": "347405d5-feda-47ef-8605-a4b603078a1e", "AdminUser": true, "DateCreated": "2025-04-24T14:03:00.2663399+00:00", "DateModified": "2025-04-24T14:03:00.2663399+00:00", "DeclineDate": "2025-04-24T14:03:00.2663399+00:00", "DisplayName": "sample string 6", "DPAVersion": "sample string 7", "EmailAddress": "sample string 8", "Enabled": true, "LanguageID": "4e1a886e-1583-4434-8964-b6a85fd8d85b", "MobilePhone": "sample string 12", "Password": "sample string 13", "Pin": "sample string 14", "Preferences": 0, "PrivacyPolicyVersion": "sample string 15", "TimeZone": "sample string 16", "Username": "sample string 17" }
application/xml, text/xml
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ID>cae9abd8-15d9-4dda-a0a5-4b14ad6ae7f8</ID> <AgreementDate>2025-04-24T14:03:00.2663399+00:00</AgreementDate> <AccountID>347405d5-feda-47ef-8605-a4b603078a1e</AccountID> <AdminUser>true</AdminUser> <DateCreated>2025-04-24T14:03:00.2663399+00:00</DateCreated> <DateModified>2025-04-24T14:03:00.2663399+00:00</DateModified> <DeclineDate>2025-04-24T14:03:00.2663399+00:00</DeclineDate> <DisplayName>sample string 6</DisplayName> <DPAVersion>sample string 7</DPAVersion> <EmailAddress>sample string 8</EmailAddress> <Enabled>true</Enabled> <LanguageID>4e1a886e-1583-4434-8964-b6a85fd8d85b</LanguageID> <Language>sample string 11</Language> <MobilePhone>sample string 12</MobilePhone> <Password>sample string 13</Password> <Pin>sample string 14</Pin> <Preferences>NONE</Preferences> <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion> <TimeZone>sample string 16</TimeZone> <Username>sample string 17</Username> </User>
application/x-www-form-urlencoded
Response Information
Resource Description
The modified user details.
TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Users.UserName | Description | Type | Additional information |
---|---|---|---|
Error | TwoSms.CustomerPortalRole.API.Misc.Error |
None. |
|
ResponseData | TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.Users.User |
None. |
Response Formats
application/json, text/json
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": { "ID": "cc1b871a-782c-4f18-9eb0-16453123bddf", "AgreementDate": "2025-04-24T14:03:00.2674234+00:00", "AccountID": "13f3e51d-031d-4a8e-815a-556ac67cc9d3", "AdminUser": true, "DateCreated": "2025-04-24T14:03:00.2674234+00:00", "DateModified": "2025-04-24T14:03:00.2674234+00:00", "DeclineDate": "2025-04-24T14:03:00.2674234+00:00", "DisplayName": "sample string 6", "DPAVersion": "sample string 7", "EmailAddress": "sample string 8", "Enabled": true, "LanguageID": "25fe4a3e-4dc6-496f-bc69-2c7c9c8fe049", "MobilePhone": "sample string 12", "Password": "sample string 13", "Pin": "sample string 14", "Preferences": 0, "PrivacyPolicyVersion": "sample string 15", "TimeZone": "sample string 16", "Username": "sample string 17" } } }
application/xml, text/xml
<ResponseOfUser xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail> <ID>cc1b871a-782c-4f18-9eb0-16453123bddf</ID> <AgreementDate>2025-04-24T14:03:00.2674234+00:00</AgreementDate> <AccountID>13f3e51d-031d-4a8e-815a-556ac67cc9d3</AccountID> <AdminUser>true</AdminUser> <DateCreated>2025-04-24T14:03:00.2674234+00:00</DateCreated> <DateModified>2025-04-24T14:03:00.2674234+00:00</DateModified> <DeclineDate>2025-04-24T14:03:00.2674234+00:00</DeclineDate> <DisplayName>sample string 6</DisplayName> <DPAVersion>sample string 7</DPAVersion> <EmailAddress>sample string 8</EmailAddress> <Enabled>true</Enabled> <LanguageID>25fe4a3e-4dc6-496f-bc69-2c7c9c8fe049</LanguageID> <Language>sample string 11</Language> <MobilePhone>sample string 12</MobilePhone> <Password>sample string 13</Password> <Pin>sample string 14</Pin> <Preferences>NONE</Preferences> <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion> <TimeZone>sample string 16</TimeZone> <Username>sample string 17</Username> </Detail> </ResponseData> </ResponseOfUser>