Update Entity

​

Custom update entity method that detects email changes and sends NATS message to frontegghook service.

Path Parameters

  • entity_id
    Type: string
    required

Body·

required
application/json
  • firstName
    Type: string
    required

    First Name - User's given name or first name (required)

  • areaOfResponsibility
    Type: integernullable

    Area of Responsibility ID - The functional area this user is responsible for. References the area_of_responsibility lookup table

  • avatarUrl
    Type: stringnullable

    Avatar URL - URL to the user's profile picture or avatar image

  • department
    Type: integernullable

    Department ID - The department this user belongs to. References the departments lookup table

  • displayName
    Type: stringnullable

    Display Name - Friendly name shown in the UI. If not provided, defaults to 'First Last'

  • email
    Type: stringnullable

    Email Address - User's primary email address. Must be unique across the account. Used for authentication and notifications

  • groupIds
    Type: array of stringnullable

    Group IDs - List of group IDs this user belongs to. Can be provided as comma-separated string or array

  • jobTitle
    Type: stringnullable

    Job Title - User's position or title within the organization

  • lastName
    Type: stringnullable

    Last Name - User's family name or surname

  • managerId
    Type: stringnullable

    Manager ID - User ID of this user's direct manager. Must start with 'u-'. Used for organizational hierarchy

  • quotaPlan
    Type: integernullable

    Quota Plan ID - The quota/target plan assigned to this user. Determines performance metrics and goals

  • role
    Type: integernullable

    Role ID - User's role determining permissions and access levels. References the roles lookup table

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
Request Example for put/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/users/{entity_id}' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "lastName": "Smith",
  "displayName": "John Smith",
  "department": 1,
  "areaOfResponsibility": 1,
  "email": "john.smith@company.com",
  "role": 1,
  "jobTitle": "Account Executive",
  "userLanguage": "en",
  "avatarUrl": "https://example.com/avatars/user123.jpg",
  "groupIds": [
    "g-sales",
    "g-enterprise"
  ],
  "quotaPlan": 1,
  "managerId": "u-manager123",
  "timezone": "America/New_York",
  "firstName": "John",
  "additionalProperty": "anything"
}'

{
  "lastName": "Smith",
  "displayName": "John Smith",
  "department": 1,
  "areaOfResponsibility": 1,
  "email": "john.smith@company.com",
  "role": 1,
  "jobTitle": "Account Executive",
  "userLanguage": "en",
  "avatarUrl": "https://example.com/avatars/user123.jpg",
  "groupIds": [
    "g-sales",
    "g-enterprise"
  ],
  "quotaPlan": 1,
  "managerId": "u-manager123",
  "timezone": "America/New_York",
  "firstName": "John",
  "status": 1,
  "lastLoginAt": "2024-01-15T10:30:00Z",
  "directReports": [
    "string"
  ],
  "roleName": "string",
  "departmentName": "string",
  "areaOfResponsibilityName": "string"
}

Successful Response