POST /api/public/bulk-user-import/

Endpoint for uploading a bulk user import file.

Returns the result of processing of the bulk import: ok, error, or queued.

See Settings: People > Import page for details on CSV file formatting.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
email String No

Email address where the results will be emailed.

csv_file String No

The file to upload, encoded as UTF-8.

unique_identifier String No

Field used to identify existing profiles. If not provided, the company's "Employee identifier" setting (Company settings > Import settings) will be used.

Possible values:

  • "email"
  • "employee_id"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.