Update a user

PUT  https://:account.api-us1.com/api/3/users/:id

• cURL

curl --request PUT \
  --url https:///:account.api-us1.com/api/3/users/:id

• Node

var request = require("request");

var options = { method: 'PUT',
  url: 'https:///:account.api-us1.com/api/3/users/:id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

• Ruby

require 'uri'
require 'net/http'

url = URI("https:///:account.api-us1.com/api/3/users/:id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

• JavaScript

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https:///:account.api-us1.com/api/3/users/:id");

xhr.send(data);

• Python

import requests

url = "https:///:account.api-us1.com/api/3/users/:id"

response = requests.request("PUT", url)

print(response.text)

 

200 OK

{
  "userGroups": [
    {
      "userid": "3",
      "groupid": "3",
      "links": {
        "group": "https://:account.api-us1.com/api/3/userGroups/3/group",
        "user": "https://:account.api-us1.com/api/3/userGroups/3/user"
      },
      "id": "3",
      "group": "3",
      "user": "3"
    }
  ],
  "user": {
    "username": "user",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "phone": "",
    "signature": "",
    "userGroup": "3",
    "links": {
      "lists": "https://:account.api-us1.com/api/3/users/3/lists",
      "userGroup": "https://:account.api-us1.com/api/3/users/3/userGroup",
      "dealGroupTotals": "https://:account.api-us1.com/api/3/users/3/dealGroupTotals",
      "dealGroupUsers": "https://:account.api-us1.com/api/3/users/3/dealGroupUsers",
      "configs": "https://:account.api-us1.com/api/3/users/3/configs"
    },
    "id": "3"
  }
}

PATH PARAMS

ID                                         REQUIRED

int32                                    ID of the user

 

BODY PARAMS

user

object

 

user.username

string                                    Username. Username cannot be changed!

 

user.password

string                                    Password. Example: 'newpassword'

 

user.email

string                                    Email address of the user. Example: '[e-mail]'

 

user.firstName

string                                    First name of the user. Example: 'FirstName'

 

user.lastName

string                                    Last name of the user. Example: 'LastName'

 

user.group

int32                                     Assign to Groups