Migrate Documents

POST /v2/organizations/documents/migrate

Migrate Documents

cURL

curl --request POST \
  --url https://api.velt.dev/v2/organizations/documents/migrate \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "documentId": "<string>",
    "newDocumentId": "<string>"
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Document migration started successfully.",
    "data": {
      "migrationId": "yourMigrationId"
    }
  }
}

Use this API to migrate a document to a new document ID within an organization. Returns a migrationId that can be used to poll the migration status.

Endpoint

POST https://api.velt.dev/v2/organizations/documents/migrate

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

Organization ID

documentId · string · required

ID of the document to migrate

newDocumentId · string · required

New document ID to migrate the document to

Example Requests

Migrate a document to a new document ID

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "newDocumentId": "yourNewDocumentId"
  }
}

Response

Success Response

Use the returned migrationId to poll progress with the Migrate Documents Status endpoint.

{
  "result": {
    "status": "success",
    "message": "Document migration started successfully.",
    "data": {
      "migrationId": "yourMigrationId"
    }
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "status": "success",
    "message": "Document migration started successfully.",
    "data": {
      "migrationId": "yourMigrationId"
    }
  }
}