Update a user

Updates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/users/{id}

JWT

user:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the user.

Request Body Schema

Property	Type	Description	Constraints
firstName	string	First name of the user.	min: 1, max: 256
lastName	string	Last name of the user.	min: 0, max: 256
email	string	Email address of the user.	min: 1, max: 256, format: email
company	string	Company of the user.	min: 0, max: 256
organizationId	string	Unique identifier for the organization.	min: 0, max: 256
resellerId	string	Unique identifier for the reseller.	min: 0, max: 256
allowCustomerPortalAccess	boolean	Allow customer portal access.
metadata	array	List of metdata key/value pairs.	items: object
key*	string	Name of the key.	min: 1, max: 256
value*	string	Value of the key.	min: 0, max: 4096
viewPermissions	array	Array of view permissions associated with the metadata.	items: string
tags	array	List of tags.	items: string
role	string	Role of the user.	min: 1, max: 256

Request Example

{
  "firstName": "string",
  "lastName": "string",
  "email": "user@example.com",
  "company": "string",
  "organizationId": "string",
  "resellerId": "string",
  "allowCustomerPortalAccess": true,
  "metadata": [
    {
      "key": "string",
      "value": "string",
      "viewPermissions": [
        "activation"
      ],
      "visible": true
    }
  ],
  "tags": [
    "string"
  ],
  "role": "string"
}

Triggers webhook: user.updated

POST <your-webhook-url>
{
  "event": "user.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "role": "string",
    "twoFactorEnabled": true,
    "googleSsoEnabled": true,
    "lastLoginAt": "2019-08-24T14:15:22Z",
    "company": "string",
    "allowCustomerPortalAccess": true,
    "roles": [
      "string"
    ],
    "lastSeenAt": "2019-08-24T14:15:22Z",
    "organizationId": "string",
    "organization": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "email": "string",
      "description": "string",
      "allowedUsers": 0,
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      },
      "resellerId": "string",
      "reseller": {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "email": "string",
        "description": "string",
        "allowedUsers": 0,
        "allowedOrganizations": 0
      }
    },
    "resellerId": "string",
    "reseller": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "email": "string",
      "description": "string",
      "allowedUsers": 0,
      "allowedOrganizations": 0
    },
    "metadata": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "key": "string",
        "value": "string",
        "viewPermissions": [
          "activation"
        ],
        "visible": true
      }
    ],
    "tags": [
      "string"
    ],
    "emailPreference": {
      "metrics": true
    }
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "role": "string",
  "twoFactorEnabled": true,
  "googleSsoEnabled": true,
  "lastLoginAt": "2019-08-24T14:15:22Z",
  "company": "string",
  "allowCustomerPortalAccess": true,
  "roles": [
    "string"
  ],
  "lastSeenAt": "2019-08-24T14:15:22Z",
  "organizationId": "string",
  "organization": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "email": "string",
    "description": "string",
    "allowedUsers": 0,
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postalCode": "string"
    },
    "resellerId": "string",
    "reseller": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "email": "string",
      "description": "string",
      "allowedUsers": 0,
      "allowedOrganizations": 0
    }
  },
  "resellerId": "string",
  "reseller": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "email": "string",
    "description": "string",
    "allowedUsers": 0,
    "allowedOrganizations": 0
  },
  "metadata": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "key": "string",
      "value": "string",
      "viewPermissions": [
        "activation"
      ],
      "visible": true
    }
  ],
  "tags": [
    "string"
  ],
  "emailPreference": {
    "metrics": true
  }
}