Users

Updating users

You can update a user using a PUT request to the /users/{id} endpoint. To do this you need to know the exact ‘link’ associated with the user.

The application must provide all the fields during the update request, even if they’re not being updated.

Any missing fields, except for the password field, will be automatically removed from the existing record.

The Content-Type can be:

  • application/vnd.whispir.user-v1+xml
    or
  • application/vnd.whispir.user-v1+json

Note: You can't selectively update the user fields needed as this is a PUT request.

So the standard process for updating a user record is:

  1. GET /users/{id of user}.
  2. Update the user field in the object to the required value.
  3. PUT /users/{id of user} the new object.

The response to the PUT request on success is usually a 204 response with no content being provided.

  • JSON
  • XML

Updating users

The following endpoints allow users to update users using the Whispir API:

{{codeStart}}

HTTP 1.1 PUT https://api.<region>.whispir.com/users/CB4558257DD86D09?apikey=<your_api_key>

Authorization: Basic am9obi5zbWl0aDpteXBhc3N3b3Jk

x-api-key: your_api_key

Content-Type: application/vnd.whispir.user-v1+json

{

"firstName": "John",

"lastName": "Wick",

"timeZone": "+8",

"jobTitle": "Whispir API Specialist",

... remainder of the user object

}

{{codeEnd}}

The response to the PUT request upon success is a 204 No Content response with no content being provided.