Users Management

Create new user

Schedules a task to create a new user and returns the task's data. You can track this task here. You can get created user here.

post/accounts/{account_id}/users/foreign

Request

  • Base URL: https://api.huntflow.ru/v2
  • URL: https://api.huntflow.ru/v2/accounts/{account_id}/users/foreign
  • Auth: HTTP bearer

Path parameters

account_idinteger required

Request body

idstring required

Foreign User ID

namestring required

User name

emailstring email required

Email

type'owner' | 'manager' | 'watcher' required

An enumeration.

head_idstring

Foreign user ID of head

division_idsstring[]

Foreign IDs of available divisions. If field is not provided, contains null or empty list, it means access to all divisions

permissionsstring[]

User permissions

metaobject

Additional meta information

Example request

{
  "id": "user-032155",
  "name": "John Doe",
  "email": "mail@gmail.com",
  "head_id": "user-032044",
  "division_ids": [
    "division-154",
    "division-871"
  ],
  "permissions": [
    "invite-watchers",
    "create-vacancies"
  ]
}

Response

Successful Response

task_idstring uuid required

Task ID

action'CREATE' | 'UPDATE' | 'DELETE' required

An enumeration.

createdstring date-time required

Task creation time

Example response

{
  "created": "2020-01-01T00:00:00+03:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.