moveItemsToFolder

File items into a folder (folderId), or to the top level (folderId: null). items are { kind, id }; kind is FILTER, CONTACT_LIST, PROPERTY_LIST, FORM, TEMPLATE, LIBRARY_FILE or WORKFLOW_GROUP. All or nothing: one id not found refuses the whole call. Refused when the folder's surface does not hold that kind. A saved filter's privacy FOLLOWS the folder: into a personal folder makes it private to you, into a shared one shares it with the team, so say so before moving a filter across. Returns how many moved.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "moveItemsToFolder",
    "variables": {
      "items": [
        {
          "kind": "FILTER",
          "id": "<id>"
        }
      ]
    }
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

// Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type.
const variables = {
  items: [
    {
      kind: 'FILTER',
      id: '<id>'
    }
  ]
} as Parameters<typeof goliath.properties.moveItemsToFolder>[0]

const result = await goliath.properties.moveItemsToFolder(variables, { idempotencyKey: crypto.randomUUID() })

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'moveItemsToFolder',
    variables: {
      items: [
        {
          kind: 'FILTER',
          id: '<id>'
        }
      ]
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

items[FolderItemRef!]!required

One item, named by what it is and which row it is. Ids are only unique within a kind (`Tag` and `ContactTag` are different tables) so the kind is not decoration, it is half the identity.

kindFoldableKind!required

A thing that can live in a folder. One entry per foldable table. Not every kind can do everything: only FILTER can be private (and therefore live in a personal folder), and TEMPLATE has no display order and so cannot be reordered. The server refuses those rather than accepting them silently.

FILTERPROPERTY_LISTCONTACT_LISTTEMPLATELIBRARY_FILEWORKFLOW_GROUPFORM

idID!required

folderIdID

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "folderMutation": {
      "moveItemsToFolder": 0
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{ "operationId": "moveItemsToFolder", "variables": { "items": [ { "kind": "FILTER", "id": "<id>" } ] } }'

import { GoliathClient } from '@goliath-data/sdk' const goliath = new GoliathClient({ apiKey: process.env.GOLIATH_API_KEY!, baseUrl: 'https://server.goliathdata.com', }) // Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type. const variables = { items: [ { kind: 'FILTER', id: '<id>' } ] } as Parameters<typeof goliath.properties.moveItemsToFolder>[0] const result = await goliath.properties.moveItemsToFolder(variables, { idempotencyKey: crypto.randomUUID() })

const res = await fetch('https://server.goliathdata.com/api/v1/call', { method: 'POST', headers: { Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`, 'Content-Type': 'application/json', 'Idempotency-Key': crypto.randomUUID(), }, body: JSON.stringify({ operationId: 'moveItemsToFolder', variables: { items: [ { kind: 'FILTER', id: '<id>' } ] } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Idempotency

Related