GoliathDevelopersGet an API key
Reference/Contractsgenerated from the gateway manifest

archiveContractTemplate

Take a template out of the list and the pickers (status ARCHIVED).

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

Take a template out of the list and the pickers (status ARCHIVED). Contracts already sent from it are not changed, but they leave the Contracts list with it for its Archived view, so tell the person how many went out first (listContractTemplates). Undo with unarchiveContractTemplate. A one-off PDF (sent without a template) is discarded for good instead. Needs the manage contracts capability.

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": "archiveContractTemplate",
    "variables": {
      "input": {
        "templateId": "<templateId>"
      }
    }
  }'
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.archiveContractTemplate(
  {
    input: {
      templateId: '<templateId>'
    }
  },
  { 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: 'archiveContractTemplate',
    variables: {
      input: {
        templateId: '<templateId>'
      }
    }
  }),
})
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.

inputAdminContractArchiveTemplateInput!required
templateIdID!required

Response

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

response shape
{
  "data": {
    "contractsMutation": {
      "archiveTemplate": {
        "id": "<ID>",
        "name": "…",
        "status": "DRAFT"
      }
    }
  }
}

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 →

READlistContractTemplatesREADlistContractsREADlistContactContractsREADlistDealContractsREADgetContractREADgetContractSendDraft