GoliathDevelopersGet an API key
Reference/Contractsgenerated from the gateway manifest

getContractSendDraft

Step 1 of preparing a contract.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

Step 1 of preparing a contract: a PUBLISHED template filled for one contact (optionally a deal, and contactBId for a co-seller). Returns the template version, the CRM-filled values (a required one left blank needs a value: their words or ask, never an invented price, date or address), missingTokens, one suggested recipient per role, and the subject, message and expiry. Needs the manage contracts capability. Then prepareContract.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getContractSendDraft",
    "variables": {
      "input": {
        "templateId": "<templateId>",
        "contactId": "<contactId>"
      }
    }
  }'
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.contracts.getContractSendDraft({
  input: {
    templateId: '<templateId>',
    contactId: '<contactId>'
  }
})
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',
  },
  body: JSON.stringify({
    operationId: 'getContractSendDraft',
    variables: {
      input: {
        templateId: '<templateId>',
        contactId: '<contactId>'
      }
    }
  }),
})
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.

inputAdminContractSendStartInput!required
templateIdID!required
contactIdID!required
pipelineItemIdID

Optional deal for the deal merge fields; must belong to the same organization.

dealIdID
contactBIdID

Optional Contact B (a co-seller) for the template's second contact role.

Response

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

response shape
{
  "data": {
    "contractsQuery": {
      "sendDraft": {
        "templateId": "<ID>",
        "templateVersionId": "<ID>",
        "templateName": "…",
        "title": "…",
        "dealId": "<ID>",
        "contact": {
          "id": "<ID>",
          "name": "…",
          "emails": [
            "…"
          ],
          "phones": [
            "…"
          ]
        },
        "contactB": {
          "id": "<ID>",
          "name": "…",
          "emails": [
            "…"
          ],
          "phones": [
            "…"
          ]
        },
        "values": [
          {
            "key": "<ID>",
            "label": "…",
            "source": "TOKENS",
            "required": true,
            "value": "…",
            "record": "CONTACT"
          }
        ],
        "missingTokens": [
          "…"
        ],
        "roles": [
          {
            "key": "<ID>",
            "label": "…",
            "kind": "SIGNER",
            "order": 0
          }
        ],
        "recipients": [
          {
            "roleKey": "<ID>",
            "displayName": "…",
            "email": "…",
            "phone": "…",
            "contactId": "<ID>",
            "signingOrder": 0
          }
        ],
        "subject": "…",
        "message": "…",
        "expiryDays": 0,
        "reminderIntervalDays": 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.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READlistContractTemplatesREADlistContractsREADlistContactContractsREADlistDealContractsREADgetContractREADgetHeldContractDraft