GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

createPipeline

Create a deal pipeline in your organization.

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

Create a deal pipeline in your organization. Requires a title; optionally a description and an ordered list of initial stages (each: name, plus optional description, order, isTerminal, terminalType WON|LOST|NEUTRAL, winProbability 0-100). Returns the created pipeline: its id, name, description and stages in order.

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": "createPipeline",
    "variables": {
      "title": "<String>"
    }
  }'
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.createPipeline(
  {
    title: '<String>'
  },
  { 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: 'createPipeline',
    variables: {
      title: '<String>'
    }
  }),
})
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.

titleString!required
descriptionString
stages[PipelineStageCreateInput!]
nameString!required
descriptionString
orderFloat
isTerminalBoolean
terminalTypePipelineStageTerminalType
WONLOSTNEUTRAL
winProbabilityInt

Response

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

response shape
{
  "data": {
    "dealMutation": {
      "createPipeline": {
        "id": "<ID>",
        "name": "…",
        "description": "…",
        "stages": [
          {
            "id": "<ID>",
            "name": "…",
            "order": 0,
            "isTerminal": true,
            "terminalType": "WON",
            "winProbability": 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 →

READgetDealREADfindDealsREADsurveyDealsREADlistStalledDealsREADlistPipelinesREADlistDealFilters