Appearance
User
User profile and settings: profile info, settings, password change, profile pictures, and companies.
Endpoints
| Endpoint | Arguments | Returns |
|---|---|---|
user.add_profile_pic_to_user | Object { file_id: String id } | boolean |
user.change_password | Object { oldPassword: string, newPassword: string } | boolean |
user.get_companies | - | object[] |
user.get_profile_info | - | unknown |
user.load | String userId or String[] userIds | object | Record<string, object> |
user.remove_profile_pic | String fileId | boolean |
user.save_settings | String key, String value | boolean |
user.set_default_profile_pic | String id | boolean |
user.set_user_info | String key, String value or string[] | boolean |
user.add_profile_pic_to_user
Description
Add profile picture to current user
Parameters
Argument 1 (object, required):
| Field | Type | Required | Description |
|---|---|---|---|
file_id | ObjectId | yes |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.add_profile_pic_to_user', [
{
file_id: '507f1f77bcf86cd799439011',
},
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.change_password
Description
Change password for current user
Parameters
Argument 1 (object, optional):
| Field | Type | Required | Description |
|---|---|---|---|
old | string | number | yes | |
new | string | number | yes |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.change_password', [
{
old: 'string',
new: 'string',
},
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.get_companies
Description
Get companies for current user.
Parameters
Undocumented
This endpoint declares no argument schema in the source yet.
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.get_companies', []);
console.log(result);Returns
Array of objects:
| Field | Type | Required | Description |
|---|---|---|---|
_id | WorkspaceId | yes | workspaceId (former networkId) |
name | string | no |
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.get_profile_info
Description
Get profile info for current user
Parameters
Undocumented
This endpoint declares no argument schema in the source yet.
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.get_profile_info', []);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.load
Description
Get user info by id, or a batch by passing an array of ids (max 200). A single id returns one user object (or NotFound); an array returns an id-keyed map whose values are the user object or null for ids that are not found / not authorized.
Parameters
Argument 1 (ObjectId \| ObjectId[], required):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.load', [
'507f1f77bcf86cd799439011', // argument 1 (required)
]);
console.log(result);Returns
object \| Record<string, object>
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.remove_profile_pic
Description
Remove profile picture for current user
Parameters
Argument 1 (ObjectId, required):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.remove_profile_pic', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.save_settings
Description
Write key value settings for current user in current eco system.
Parameters
Argument 1 (string \| useEnter\|calendarView\|calendarFields\|calendarUsers\|favoriteProcesses\|geoLocation\|messenger_sendOnEnter\|calendarsSelected\|calendarHideUnassigned\|filterResources\|activityCalendarFields\|starredProcessesOnly\|allCalendarUsers``, required):
Argument 2 (any, optional):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.save_settings', [
'string', // argument 1 (required)
'...', // argument 2
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.set_default_profile_pic
Description
Set default profile picture for current user
Parameters
Argument 1 (ObjectId, required):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.set_default_profile_pic', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
user.set_user_info
Description
Set user info (String key: default_company/lastLocation/status/firstname/lastname/email/preferredLanguages)
Parameters
Argument 1 (default_company` \| `lastLocation` \| `status` \| `firstname` \| `lastname` \| `email` \| `preferredLanguages, required): One of: default_company, lastLocation, status, firstname, lastname, email, preferredLanguages.
Argument 2 (any, optional):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('user.set_user_info', [
'default_company', // argument 1 (required)
'...', // argument 2
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.