GoliathDevelopersGet an API key
Reference/Accountgenerated from the gateway manifest

updateMyProfile

Update the key owner's own profile.

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

Update the key owner's own profile. All three of firstName, lastName, and phoneNumber are required together (send the current values for the ones you're not changing: read them with getMyProfile); an EMPTY phoneNumber clears the number. Two more fields are OPTIONAL and PARTIAL: profilePictureUrl (an https URL to the new picture) and howDidYouHearAboutUs (free text): omit either and the stored value is left untouched, send it to set it. The phone number is normalized and must be unique across users; email is not editable here (parity with the app). Returns the updated profile including profilePictureUrl, so quote what came back rather than assuming the picture took.

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": "updateMyProfile",
    "variables": {
      "firstName": "<String>",
      "lastName": "<String>",
      "phoneNumber": "<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.account.updateMyProfile(
  {
    firstName: '<String>',
    lastName: '<String>',
    phoneNumber: '<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: 'updateMyProfile',
    variables: {
      firstName: '<String>',
      lastName: '<String>',
      phoneNumber: '<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.

firstNameString!required
lastNameString!required
phoneNumberString!required
profilePictureUrlString
howDidYouHearAboutUsString

Response

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

response shape
{
  "data": {
    "users": {
      "updateUserProfile": {
        "id": "<ID>",
        "firstName": "…",
        "lastName": "…",
        "email": "…",
        "phoneNumber": "…",
        "profilePictureUrl": "…"
      }
    }
  }
}

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 →

READgetIntegrationSetupUrlsREADgetMyProfileREADgetMyCapabilitiesREADgetOrganizationAreasOfOperationREADlistDirectMailLettersADMINlistIntegrations