PUT v3/users/:param - Update

The API allows for the update of a single or multiple parameters on a user record in the VitalSource Bookshelf system. This can be used to update user metadata or reset a user's password.

• Verb/URI
• Data Definitions
  • Security Questions
• Request Headers
  • Request body - reference user example
  • Request body - full user example
• Response
  • Response body - reference user example
  • Response body - full user example
  • Response descriptions
• Error Codes

Verb/URI

PUT https://api.vitalsource.com/v3/users.xml/:{GUID}

Data Definitions

This request has the same format as v3/users - Create however, passing the <redemption-code> option is not available on update. You can pass all elements on update or a single element that requires the update.

Security Questions

Below are the fixed set of security questions offered by VitalSource. Integrators may select any combination for use. VitalSource does not support custom questions. Question ID's 1-5 are deprecated and no longer supported, except in legacy integrations.

Request Headers

The associated user access token is a required element in the header on update

X-VitalSource-API-Key: ALLCAPSANDNUMBERS
X-VitalSource-Access-Token: lowercaseandnumbers
Content-type: text/xml

Request body - reference user example

<user>
 <reference>Updated_Reference_String</reference>
 <first-name>Jose</first-name>
 <last-name>Tester</last-name>
</user> 

Request body - full user example

<?xml version="1.0" encoding="UTF-8"?>
<user>
 <password>QXZY#%123DaF.45</password>
 <email>jose.hernandez2@univ.edu</email>
 <first-name>Jane</first-name>
 <last-name>Hernandez</last-name>
 <question-id>7</question-id>
 <question-response>Strawberry</question-response>
 <promote-option>0</promote-option>
 <survey-option>0</survey-option>
 <affiliate>Univ of Leeds</affiliate>
 <locale>es</locale>
</user>

Response

Response body - reference user example

<?xml version="1.0" encoding="UTF-8"?>
<user>
 <email>CAPSANDNUMBERS@placeholder.1111.edu</email>
 <first-name>Jose</first-name>
 <last-name>Tester</last-name>
 <guid>ALLCAPSANDNUMBERS</guid>
 <access-token>lowercaseandnumbers</access-token>
 <library>
 </library>
</user>

Response body - full user example

<?xml version="1.0" encoding="UTF-8"?>
<user>
 <email>jose.hernandez@univ.edu</email>
 <first-name>Jose</first-name>
 <last-name>Hernandez</last-name>
 <guid>ALLCAPSANDNUMBERS</guid>
 <access-token>lowercaseandnumbers</access-token>
 <library>
 </library>
</user>

Response Descriptions

Error Codes