Activity import

Import activities from a file.

Endpoints

Endpoint	Arguments	Returns
v3.activity.import	fileId: string, options?: { deleteFile?: boolean }	unknown

v3.activity.import

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (fileId, required): fileId

Argument 2 (object, optional):

Field	Type	Required	Description
deleteFile	boolean	no	Remove file after import is complete.

Example

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('v3.activity.import', [
  '507f1f77bcf86cd799439011', // fileId (required)
  {
    deleteFile: false, // Remove file after import is complete.
  },
]);
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? }.