GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

renameContactTag

Rename a FREE-FORM contact tag in place (tagId from searchContactTags tags).

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

Rename a FREE-FORM contact tag in place (tagId from searchContactTags tags). THIS IS THE CORRECT WAY TO FIX A TAG NAME: deleteContactTags plus createContactTag is irreversible and drops the tag off every contact, while a rename keeps the id, so every contact, saved filter and workflow referencing it still points at it. Applied synchronously; returns the org tag catalog with the new name. FREE-FORM TAGS ONLY: a LIST id is refused (renameContactList) and so is a custom-field id (updateContactCustomField). Names are unique in the organization, case- and whitespace-insensitively, so renaming onto an existing tag's name, or the tag's own current name, is rejected, as is a name a custom field holds. A rename does not merge tags: to consolidate, tag the contacts with the survivor first, then delete the loser.

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": "renameContactTag",
    "variables": {
      "tagId": "<tagId>",
      "newName": "<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.contacts.renameContactTag(
  {
    tagId: '<tagId>',
    newName: '<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: 'renameContactTag',
    variables: {
      tagId: '<tagId>',
      newName: '<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.

tagIdID!required
newNameString!required

Response

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

response shape
{
  "data": {
    "contactMutation": {
      "renameFreeFormTag": {
        "contactTags": [
          {
            "id": "<ID>",
            "name": "…"
          }
        ]
      }
    }
  }
}

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