bulkUpdateDeals

One updateDeal input for many deals (stage, close date, owners, contacts); every id must be a deal your org owns or shares, or the whole call is refused. Each deal runs a full updateDeal, so a stage move wakes workflows: confirm as updateDeal says. Large sets run as a background task (bulkTaskId, getBulkTask).

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": "bulkUpdateDeals",
    "variables": {
      "dealIds": [
        "<dealIds>"
      ],
      "input": {}
    }
  }'

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.deals.bulkUpdateDeals(
  {
    dealIds: [
      '<dealIds>'
    ],
    input: {}
  },
  { 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: 'bulkUpdateDeals',
    variables: {
      dealIds: [
        '<dealIds>'
      ],
      input: {}
    }
  }),
})
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.

dealIds[ID!]!required

inputPipelineItemMutationInput!required

titleString

stageIdID

descriptionString

priceCentsBigInt

commissionAmountCentsBigInt

commissionPercentBpsInt

teamSplitAmountCentsBigInt

teamSplitPercentBpsInt

participantSplits[PipelineItemParticipantSplitInput!]

closeDateDateTime

propertyIds[ID!]

propertyStrings[String!]

contactIds[ID!]

userIds[ID!]

fileIds[ID!]

orderInt

customFieldValues[PipelineItemCustomFieldValueInput!]

Every field, all the way down

variables

[
  {
    "name": "dealIds",
    "type": "[ID!]!",
    "required": true,
    "description": null,
    "defaultValue": null
  },
  {
    "name": "input",
    "type": "PipelineItemMutationInput!",
    "required": true,
    "description": null,
    "defaultValue": null,
    "fields": [
      {
        "name": "title",
        "type": "String",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "stageId",
        "type": "ID",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "description",
        "type": "String",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "priceCents",
        "type": "BigInt",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "commissionAmountCents",
        "type": "BigInt",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "commissionPercentBps",
        "type": "Int",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "teamSplitAmountCents",
        "type": "BigInt",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "teamSplitPercentBps",
        "type": "Int",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "participantSplits",
        "type": "[PipelineItemParticipantSplitInput!]",
        "required": false,
        "description": null,
        "defaultValue": null,
        "fields": [
          {
            "name": "userId",
            "type": "ID!",
            "required": true,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "splitAmountCents",
            "type": "BigInt",
            "required": false,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "splitPercentBps",
            "type": "Int",
            "required": false,
            "description": null,
            "defaultValue": null
          }
        ]
      },
      {
        "name": "closeDate",
        "type": "DateTime",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "propertyIds",
        "type": "[ID!]",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "propertyStrings",
        "type": "[String!]",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "contactIds",
        "type": "[ID!]",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "userIds",
        "type": "[ID!]",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "fileIds",
        "type": "[ID!]",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "order",
        "type": "Int",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "customFieldValues",
        "type": "[PipelineItemCustomFieldValueInput!]",
        "required": false,
        "description": null,
        "defaultValue": null,
        "fields": [
          {
            "name": "customFieldId",
            "type": "ID!",
            "required": true,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "textValue",
            "type": "String",
            "required": false,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "dateValue",
            "type": "DateTime",
            "required": false,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "numberValue",
            "type": "Float",
            "required": false,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "dropdownSelectedValues",
            "type": "[String!]",
            "required": false,
            "description": null,
            "defaultValue": null
          }
        ]
      }
    ]
  }
]

Response

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

response shape

{
  "data": {
    "dealMutation": {
      "bulkUpdateDeals": {
        "mode": "SYNC",
        "updatedDealCount": 0,
        "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 →

Variables

Response

Errors

Idempotency

Related