PUT User

PUT User

The PUT User API allows you to update an existing user.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format.  Specify either XML or JSON.

/api/v2/user?format=xml/json

Endpoints & API Explorer

NodeAPI EndpointAPI Explorer
USapi/v2/userModel Description/Schema & Parameters

Parameters

The PUT verb on the User API allows you to update a specified user’s details. The required and optional parameters for a PUT call to the User API are outlined below: 

NameTypeDescriptionRequired
IdStringThe user’s unique identity. This value must be a GUID and can be obtained from the User Search API.✓
TypeStringThe type of user account. Options are: [‘Full’, ‘Premium’, ‘Standard’, ‘Lite’]
FirstNameStringThe user’s first name.
LastNameStringThe user’s last name.
EmailStringThe user’s email address.
PasswordStringThe user’s password.
StatusStringThe user’s account status.
ExternalIdStringThe external ID of the user’s account.
TimeZoneStringThe full name of the timezone, e.g., Central Standard Time.
CountryStringThe user’s country.
WebsiteRoleStringThe user’s website access permissions.
FoldersArrayThe folders the user is assigned.
GroupsArrayThe groups the user is assigned.
DoNotEmailBooleanFlag whether to send the user email or not.
ColorCodeStringAssign this user a unique hexadecimal HTML color code. This will be used in various parts of the platform where users are identified by their color.
MetadataArrayAdditional information about this user specified as key/value pairs.
UseNamesBooleanUse Names instead of GUID identifier for any Groups and Folders values
UseExternalIdsBooleanUse External ID instead of GUID identifier for any Groups and Folders values.
LoginIDStringThe username or other such non-email identifier as defined in your external identity provider when Email-less Login is enabled.
By default is user email.
CompanyIdIntegerYour unique Company Id found on the Organisation Setup page of the secure website.✓
IntegrationKeyStringYour unique Integration Key found on the Organisation Setup page of the secure website.✓

Example

Given that the API is REST-based, you can access the API directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.

Request URL

{
  "Id": "2ebc64a36a0d400dXXXXXXXX",
  "Type": "Standard",
  "CompanyId": XXXXX,
  "IntegrationKey": "78eec3032af240fXXXXXXXXX"
}

Request Body

{
  "Id": "2ebc64a36a0d400dXXXXXXXX",
  "Type": "Standard",
  "CompanyId": XXXXX,
  "IntegrationKey": "78eec3032af240fXXXXXXXXX"
}

Response Body

{
  "User": {
    "Id": "2ebc64a36a0d400XXXXXXXX",
    "Type": "Standard",
    "FirstName": "Mc",
    "LastName": "Testy",
    "Email": "XXXmctesty@example.com",
    "Status": "Active",
    "ExternalId": "XXX",
    "TimeZone": "Universal Standard Time",
    "TimeZoneOffSet": 120,
    "Country": "BA",
    "WebsiteRole": "ReadOnly",
    "CreatedDate": "2019-09-11T06:24:03.9630000Z",
    "LastUpdated": "2023-01-12T12:04:23.2518033Z",
    "LastActivity": "2021-08-30T06:28:58.1000000Z",
    "UserAudits": [
      {
        "Id": 16XXXXX,
        "Email": "XXXmctesty@example.com",
        "On": "2019-09-11T06:26:40.6428186Z",
        "Off": "2023-01-12T12:04:23.2361762Z",
        "OffReason": "TypeChange",
        "Type": "Premium",
        "Status": "Active"
      },
      {
        "Id": 16XXXXX,
        "Email": "XXXmctesty@example.com",
        "On": "2019-09-11T06:23:58.9630000Z",
        "Off": "2019-09-11T06:26:40.6428186Z",
        "OffReason": "Activated",
        "Type": "Full",
        "Status": "Invited"
      },
      {
        "Id": 16XXXXX,
        "Email": "XXXmctesty@example.com",
        "On": "2023-01-12T12:04:23.2361762Z",
        "Type": "Standard",
        "Status": "Active"
      }
    ],
    "Folders": [],
    "Groups": [
      "f3e6d6e571924XXXXXXXX"
    ],
    "Metadata": [
      {
        "Key": "NameEUI"
      }
    ],
    "CompanyId": XXXXX
  }
}

    • Related Articles

    • PUT Usergroup

      This API allows you to update an existing user group. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb. The format query string parameter controls the desired response format. Specify either XML or JSON. ...

    • PUT Folder

      This API call allows you to update an existing Folder’s properties. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb. The format query string parameter controls the desired response format. Specify either ...

    • PUT Task

      This request method allows you to update an existing task. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb. The format query string parameter controls the desired response format. Specify either XML or ...

    • PUT Task Recurring

      This request method allows you to update an existing recurring task. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb. The format query string parameter controls the desired response format. Specify either ...

    • PUT Environment (Update)

      To update an Environment account, use a PUT with the Environment API found at our API Explorer. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired ...