Skip to content
Browse docsupdate_person

update_person

Updates contact identity in your private Rolodex. Read get_person first. For corrections to Gravity’s profile of the person, use add_notes.

InputRequiredMeaning
personyesContact identity fields and the version from Get.
person.personIdyesExact owned person from List or Get.
person.etagyesQuoted opaque etag copied unchanged from Get.
person.ownerAuthoredNamenoYour private label, up to 120 characters.
person.linkedInnoSupplied url, company, and position.
updateMasknoComma-separated identity paths relative to Person.

Writable paths are ownerAuthoredName, linkedIn.url, linkedIn.company, and linkedIn.position. The parent path linkedIn selects all its children. Construct the input with the listed fields and the current ID and etag. Profile-content fields and legacy profile masks are rejected.

  • Omission selects supplied nonempty identity values. An empty mask ("") changes nothing.
  • Selected absent or null fields reset to their default. Clearing ownerAuthoredName restores the contact-name fallback.
  • * alone replaces all writable identity fields, resetting omitted values. Prefer an explicit mask.
  • Use add_person_email to add an email address.

Success returns the canonical Person from Get plus its Gravity link. A stale etag returns version_conflict with currentPerson, even for a no-op. Read the current person and review before retrying.

json
{
  "person": {
    "personId": "00000000-0000-4000-a000-000000000005",
    "etag": "\"cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc\"",
    "linkedIn": {
      "company": "Synthetic new company"
    }
  },
  "updateMask": "linkedIn.company"
}

The mask follows AIP-134 and AIP-161, with strict freshness from AIP-154. These JSON tool contracts use camelCase application field names.

json
{
  "personId": "00000000-0000-4000-a000-000000000005",
  "displayName": "Synthetic Pat",
  "contactAuthoredName": "Synthetic Pat",
  "ownerAuthoredName": null,
  "emails": [
    "pat@example.test"
  ],
  "etag": "\"dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd\"",
  "authoredSummary": null,
  "linkedIn": {
    "url": null,
    "company": "Synthetic new company",
    "position": "Designer"
  },
  "sections": {
    "general": [],
    "areasOfDepth": [],
    "currentWork": [
      {
        "statementId": "00000000-0000-4000-a000-000000000007",
        "text": "Building a synthetic product",
        "revision": 1,
        "scope": null,
        "uncertainty": null
      }
    ],
    "currentNeeds": [],
    "relationshipContext": [
      {
        "statementId": "00000000-0000-4000-a000-000000000008",
        "text": "You worked together",
        "revision": 1,
        "scope": null,
        "uncertainty": null
      }
    ]
  },
  "link": "https://www.meetgravity.ai/dashboard/rolodex?person=00000000-0000-4000-a000-000000000005"
}

Annotations: readOnlyHint: false · destructiveHint: true · idempotentHint: true · openWorldHint: false