Ferndesk

Users

Create help center user

Creates a help center user and stores attributes used by user-group audience rules. The email is normalized to lowercase.

POST /users

Create help center user

curl --request POST \
  --url 'https://api.ferndesk.com/v1/users' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "helpdeskId": "<string>",
  "email": "<email>",
  "name": "<string>",
  "emailVerified": true,
  "disabled": true,
  "attributes": {
    "key": "<string>"
  },
  "lastLoginAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Created help center user

Authorizations

  • Authorization string required header

    All requests require a Bearer token in the Authorization header. API keys are prefixed with fdsk_ and should be kept secret. You can generate and manage keys from the Developer settings page.

Request Body

application/json
  • email string (email) required

    Help center user email address. Emails are stored lowercase.

  • name string | null

    Optional display name for the user.

  • attributes object default

    Initial saved attributes for user-group matching. Default: {}.

    + Show Child Attributes
    • [key: string] anyOf additional
      + Show Child Attributes
      • anyOf options 4 variants anyOf

        One or more options can apply.

        + Show Child Attributes
        • option 1 string | number | boolean
        • option 2 array
          + Show Child Attributes
          • items[] string array item
        • option 3 array
          + Show Child Attributes
          • items[] number array item
        • option 4 array
          + Show Child Attributes
          • items[] boolean array item
  • disabled boolean default

    Create the user disabled. Default: false.

Response

application/json
  • id string

    Ferndesk help center user ID (hcusr_...).

  • helpdeskId string

    Ferndesk helpdesk ID (help_...).

  • email string (email)

    Help center user email address. Emails are stored lowercase.

  • name string | null

    Display name for the help center user.

  • emailVerified boolean

    Whether the email has been verified through a help center auth flow.

  • disabled boolean

    Whether the user is disabled. Disabled users cannot keep active sessions.

  • attributes object

    Saved user attributes used by user-group rules. Values may be strings, numbers, booleans, or arrays of one primitive type.

    + Show Child Attributes
    • [key: string] anyOf additional
      + Show Child Attributes
      • anyOf options 4 variants anyOf

        One or more options can apply.

        + Show Child Attributes
        • option 1 string | number | boolean
        • option 2 array
          + Show Child Attributes
          • items[] string array item
        • option 3 array
          + Show Child Attributes
          • items[] number array item
        • option 4 array
          + Show Child Attributes
          • items[] boolean array item
  • lastLoginAt string | null

    Most recent help center login timestamp, if any.

  • createdAt string

    ISO 8601 timestamp in UTC.

  • updatedAt string

    ISO 8601 timestamp in UTC.