GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

createDealCustomField

Create a custom-field DEFINITION on a deal pipeline you OWN.

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

Create a custom-field DEFINITION on a deal pipeline you OWN (pipelineId from listPipelines): name + type (TEXT | NUMBER | DOLLAR | DATE | LINK | DROPDOWN; options required and non-empty for DROPDOWN; allowMultiple/defaultValue optional). Applied synchronously. Deal custom fields are per-pipeline, and a shared pipeline cannot be modified. Returns the pipeline's field set; read the new id back by matching the name (or use listDealCustomFields), then write values via the deal's customFieldValues input on createDeal / updateDeal.

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": "createDealCustomField",
    "variables": {
      "input": {
        "name": "<String>",
        "type": "DROPDOWN"
      },
      "pipelineId": "<pipelineId>"
    }
  }'
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 = {
  input: {
    name: '<String>',
    type: 'DROPDOWN'
  },
  pipelineId: '<pipelineId>'
} as Parameters<typeof goliath.deals.createDealCustomField>[0]

const result = await goliath.deals.createDealCustomField(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: 'createDealCustomField',
    variables: {
      input: {
        name: '<String>',
        type: 'DROPDOWN'
      },
      pipelineId: '<pipelineId>'
    }
  }),
})
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.

inputCreatePipelineItemCustomFieldInput!required
nameString!required
typePipelineItemCustomFieldType!required
DROPDOWNTEXTNUMBERDOLLARDATELINK
options[String!]
defaultValueString
allowMultipleBoolean
descriptionString
pipelineIdID!required

Response

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

response shape
{
  "data": {
    "dealCustomFieldMutation": {
      "createCustomField": {
        "getPipelineCustomFields": [
          {
            "id": "<ID>",
            "name": "…",
            "type": "DROPDOWN"
          }
        ]
      }
    }
  }
}

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 →

READgetDealREADfindDealsREADsurveyDealsREADlistStalledDealsREADlistPipelinesREADlistDealFilters