Skip to main content
POST
Move multiple rows from a list to another list.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

listId
string
required

Body

application/json

Move operation data

Request body for moving rows from one list to another

rowIds
string[]
required

Array of row IDs (UUIDs) to move

targetListId
string
required

Target list ID (UUID). Must belong to the same company as the source list, and must not equal the source listId.

companyId
string

Company ID that owns the list. Required when authenticating with a personal access key (pak_…) — the key is not tied to a specific company so the server cannot infer it. Required when authenticating with a company API key only if the key belongs to a user who has access to multiple companies; otherwise it defaults to the key's company. Optional for JWT (dashboard) auth — defaults to the user's active company.

removeFromList
boolean
default:false

If true, successfully moved rows are deleted from the source list after being copied. Default: false (copy).

Response

Move result

Result of a move-to-list or move-to-sequence operation

addedCount
integer

Number of rows successfully added to the target

failedCount
integer

Number of rows that failed to move

failedRows
object[]

Per-row failure details

msg
string

Human-readable success message

removedFromList
boolean

True if rows were removed from the source list (only set when removeFromList=true was requested and at least one row was moved successfully)