PUT api/User
Updates the contact info for the user. if no UserToken is supplied then the contact info for the Account Owner will be updated.
Request Information
Authentication Method
Partner/Account AuthenticationURI Parameters
None.
Body Parameters
UserContactInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| userToken |
Use if client already has one account in SiteWit |
string |
|
| mobilePhone |
Used for SMS alerts about account |
string |
|
| name |
Name of end user |
string |
String length: inclusive between 2 and 255 |
|
Contact email address |
string |
A valid email address |
Request Formats
application/json, text/json
Sample:
{
"userToken": "sample string 1",
"mobilePhone": "sample string 2",
"name": "sample string 3",
"email": "sample string 4"
}
application/xml, text/xml
Sample:
<UserContactInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.UpdateModels"> <email>sample string 4</email> <mobilePhone>sample string 2</mobilePhone> <name>sample string 3</name> <userToken>sample string 1</userToken> </UserContactInfo>
Response Information
Successful Response:Resource Description
Collection of User Info| Name | Description | Type | Additional information |
|---|---|---|---|
| username | string |
|
|
| string |
|
||
| name | string |
|
|
| token | string |
|
|
| roles | Collection of string |
|
|
| mobilePhone | string |
|
Response Formats
application/json, text/json
Sample:
[
{
"username": "sample string 1",
"email": "sample string 2",
"name": "sample string 3",
"token": "sample string 4",
"roles": [
"sample string 1",
"sample string 2"
],
"mobilePhone": "sample string 5"
},
{
"username": "sample string 1",
"email": "sample string 2",
"name": "sample string 3",
"token": "sample string 4",
"roles": [
"sample string 1",
"sample string 2"
],
"mobilePhone": "sample string 5"
}
]
application/xml, text/xml
Sample:
<ArrayOfUserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
<UserInfo>
<email>sample string 2</email>
<mobilePhone>sample string 5</mobilePhone>
<name>sample string 3</name>
<roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</roles>
<token>sample string 4</token>
<username>sample string 1</username>
</UserInfo>
<UserInfo>
<email>sample string 2</email>
<mobilePhone>sample string 5</mobilePhone>
<name>sample string 3</name>
<roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</roles>
<token>sample string 4</token>
<username>sample string 1</username>
</UserInfo>
</ArrayOfUserInfo>
