Follow

PUT User

PUT Request

The PUT verb allows you to update a single, existing User on the platform.

You may use either JSON or XML formats in your request. 
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml". If no ContentType is specified, XML format is assumed.

The required and optional parameters for a PUT to the Users API are outlined below.

Parameter Name

Data Type

Required

Description

SUser

SUser

Yes

The User that you wish to update.  See the SUser type definition from the GET above.

 

PUT Response

The data returned from a SUser PUT is provided as follows:

SUser Response (<SUserResponse>)

Field Name

Data Type

Description

SUser

SUser

The User created.

ResponseStatus

ResponseStatus

Details of any errors that may have occurred


SUser (<SUser>) Response Fields

The SUser returned is only populated with the following fields:

Field Name

Data Type

Description

Id

GUID

Unique identifier of the new User

Status

String

Status of this User which will be set to Invited

 

API Usage Example

Given that the API is REST based, you can access the API directly via your web browser to test it.  Obviously for actual integration works, you will need to make a web request to the given REST URL and then parse the response.

Below is a simple PUT example which updates an existing User, using XML format.

Content-Type: application/xml
Content-Length: length
<SUser> <Email>String</Email> <ExternalId>String</ExternalId> <FirstName>String</FirstName> <Folders> <Id>00000000-0000-0000-0000-000000000000</Id> </Folders> <Groups> <Id>00000000-0000-0000-0000-000000000000</Id> </Groups> <Id>00000000-0000-0000-0000-000000000000</Id> <IntegrationKey>String</IntegrationKey> <LastName>String</LastName> <Password>String</Password> <ProviderId>0</ProviderId> <Status>String</Status> <WebsiteRole>String</WebsiteRole> </SUser>

XML Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <SUser>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Status>String</Status>
  </SUser>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
      </ResponseError>
    </Errors>
  </ResponseStatus>
</SUserResponse>

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk