Move Documents

POST /v1/organizations/documents/move

Move Documents

cURL

curl --request POST \
  --url https://api.velt.dev/v1/organizations/documents/move \
  --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>",
    "documentIds": [
      "<string>"
    ],
    "folderId": "<string>"
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Documents moved successfully."
  }
}

Use this API to move documents to a different folder within an organization.

Endpoint

POST https://api.velt.dev/v1/organizations/documents/move

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

documentIds · string[] · required

Array of Document IDs. Limit: Only 30 IDs can be passed at a time.

folderId · string · required

ID of the folder where documents will be moved

Example Requests

Move documents to a folder

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentIds": ["yourDocumentId1", "yourDocumentId2"],
    "folderId": "targetFolderId"
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Documents moved successfully."
  }
}

Failure Response

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

{
  "result": {
    "status": "success",
    "message": "Documents moved successfully."
  }
}