PUT User - TaskForm

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
User	User	Yes	The User that you wish to update. See the User type definition from the GET above.

PUT Response

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

User Response (<UserResponse>)

Field Name	Data Type	Description
User	User	The User created.
ResponseStatus	ResponseStatus	Details of any errors that may have occurred

User (<User>) Response Fields
The User 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.

<User>
    <CompanyId>0</CompanyId>
    <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>
    <Status>String</Status>
    <WebsiteRole>String</WebsiteRole>
</User>

XML Response

<UserResponse>
    <User>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <Status>String</Status>
    </User>
    <ResponseStatus>
        <ErrorCode>String</ErrorCode>
        <Message>String</Message>
        <Errors>
            <ResponseError>
                <ErrorCode>String</ErrorCode>
                <FieldName>String</FieldName>
                <Message>String</Message>
            </ResponseError>
        </Errors>
    </ResponseStatus>
</UserResponse>

Search Knowledge Base by Keyword