Update a reseller user

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

PATCH/v3/resellers/{resellerId}/users/{id}
JWT
reseller:user:update

Parameters

NameTypeInDescription
resellerId*stringpath
id*stringpathUnique identifier for the reseller user.

Request Body Schema

PropertyTypeDescriptionConstraints
firstNamestringFirst name of the user. //min: 1, max: 256
lastNamestringLast name of the user.min: 0, max: 256
emailstringEmail address of the user.format: email
rolestringRole of the user.min: 1, max: 256
companystringCompany of the user.min: 0, max: 256
organizationIdstringUnique identifier for the organization.min: 0, max: 256
allowCustomerPortalAccessbooleanAllow customer portal access.

Request Example

{
  "firstName": "string",
  "lastName": "string",
  "email": "user@example.com",
  "role": "string",
  "company": "string",
  "organizationId": "string",
  "allowCustomerPortalAccess": true
}
Triggers webhook: reseller.user.updated
POST <your-webhook-url>
{
  "event": "reseller.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",
    "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"
      }
    },
    "company": "string"
  },
  "triggeredAt": "string"
}

Responses

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",
  "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"
    }
  },
  "company": "string"
}