GoliathDevelopersGet an API key
Reference/Propertiesgenerated from the gateway manifest

removePropertiesFromList

Remove properties from ONE list (listId from searchPropertyTags or getProperty's lists).

POST/api/v1/callWRITEidempotent · 24 hruns as the key's owner
View as Markdown

Remove properties from ONE list (listId from searchPropertyTags or getProperty's lists). ASYNC bulk-task op: poll getBulkTask(bulkTaskId). Same selection rules as addPropertiesToList: EXPLICIT propertyIds + totalCount, or FILTER-BACKED filterId / filterTree (strict) with selectAll: true or selectCount: N for the first N in DEFAULT traversal order, never a previewed sort: use propertyIds for a sorted top-N (one window, not both; neither is REFUSED), excludeIds on the filter-backed form only. totalCount is an EXECUTION CAP, derived server-side for explicit ids and selectCount and trusted only for select-all: the filter's total from filterProperties UNSUBTRACTED; understated means the removal stops early, so round up. Not on the list is skipped, not an error. Removes MEMBERSHIP only: list and properties survive. A filter-backed selection can touch thousands of properties in one call: state the match count to the user and get a go-ahead BEFORE submitting one.

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": "removePropertiesFromList",
    "variables": {
      "listId": "<String>",
      "totalCount": 10
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

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

const result = await goliath.properties.removePropertiesFromList(
  {
    listId: '<String>',
    totalCount: 10
  },
  { 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: 'removePropertiesFromList',
    variables: {
      listId: '<String>',
      totalCount: 10
    }
  }),
})
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.

propertyIds[String!]
filterIdID
filterTreeJSON
selectAllBoolean

Default false.

selectCountInt
excludeIds[String!]
includeIncompleteRecordsBoolean
listIdString!required
totalCountInt!required

Response

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

response shape
{
  "data": {
    "propertyMutation": {
      "removePropertiesFromList": {
        "mode": "SYNC",
        "bulkTaskId": "…"
      }
    }
  }
}

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 →

READgetPropertyREADgetPropertySignalsREADgetPropertyOwnersREADfindPropertiesREADlistPropertyFiltersREADlistFilterFolders