begin-import action endpoint

URL: /blogs/<id>/begin-import.<format>

Supported Methods

POST Begin an import into the selected blog.

POST Request Object Type

This endpoint accepts the following properties in POST requests:

createUsers (boolean)
Attempt to create new users based on ones found in the imported data. This is not yet supported.
matchUsers (boolean)
Attempt to create new users based on ones found in the imported data. This is not yet supported.

Response Object Type

This endpoint returns an object with the following properties:

job (ImporterJob)
The ImporterJob object representing the job that was created.

Client Library Methods for PHP

Begin an import into the selected blog.
$tp->blogs->beginImport(array(

    # Required Parameters
    "id" => $id,
    "payload" => $payload,

))