GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

reorderContactCustomFields

Set the DISPLAY ORDER of the organization's contact custom fields.

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

Set the DISPLAY ORDER of the organization's contact custom fields. Presentation only (where fields sit on the record and in the app's field lists): no definition, option or recorded value is touched, and filtering and automations are unchanged. Pass EVERY custom-field id the organization has, in display order (first id = first position): call listContactCustomFields immediately before, reorder that complete list, send all of it. A partial list is rejected for the ids it left out, an id that is not a current custom field as unknown, and a repeated id naming the repeat: every field appears exactly once. It cannot reorder a subset.

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": "reorderContactCustomFields",
    "variables": {
      "customFieldIds": [
        "<customFieldIds>"
      ]
    }
  }'
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.contacts.reorderContactCustomFields(
  {
    customFieldIds: [
      '<customFieldIds>'
    ]
  },
  { 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: 'reorderContactCustomFields',
    variables: {
      customFieldIds: [
        '<customFieldIds>'
      ]
    }
  }),
})
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.

customFieldIds[ID!]!required

Response

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

response shape
{
  "data": {
    "contactCustomFieldMutation": {
      "reorderCustomFields": {
        "getMyOrganizationsCustomFields": [
          {
            "id": "<ID>",
            "name": "…",
            "displayOrder": 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 →

READgetContactREADgetContactsPropertiesREADfindContactsByNoteREADsearchInteractionsREADcountContactsREADfindContacts