Relationship Intelligence

Ingest relationship observations

New person sends the new person id, source user, and event person_added. The summary is that person's name followed by added by the user.

post/v1/relationship-observations/batch

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/relationship-observations/batch
  • Auth: HTTP bearer

Request body

Example request

{
  "observations": [
    {
      "accountDomain": "acme.com",
      "assertions": [
        {
          "citationsJson": "[]",
          "confidence": 0.8,
          "dimension": "health",
          "extractorVersion": "desktop-review-v1",
          "projectorCompatVersion": 2,
          "reason": "Recent engagement indicates attention is needed.",
          "sourceType": "ai_inference",
          "supersedesAssertionId": "7b8dfa9b-a7b2-46ea-982c-622a914c00e5",
          "userConfirmed": true,
          "validFrom": "2026-07-18T17:30:00Z",
          "validTo": "2026-08-18T17:30:00Z",
          "value": "needs_attention",
          "valueSchemaVersion": 1
        }
      ],
      "channel": "email",
      "direction": "inbound",
      "displayName": "Acme",
      "eventType": "person_added",
      "externalId": "1a8dfa9b-a7b2-46ea-982c-622a914c00e5",
      "occurredAt": "2026-07-31T14:00:00Z",
      "participants": [
        {
          "direction": "inbound",
          "displayName": "Jordan Buyer",
          "email": "buyer@example.com",
          "externalRefs": [
            "gmail:contact:123"
          ],
          "role": "contact",
          "title": "VP Engineering"
        }
      ],
      "primaryEmail": "avery@acme.com",
      "receivedAt": "2026-07-18T17:30:01Z",
      "relationshipId": "9c8dfa9b-a7b2-46ea-982c-622a914c00e5",
      "resourceRefs": [
        "desktop:relationship:acme"
      ],
      "source": "user",
      "sourceAccountId": "me@company.com",
      "sourceVersion": "1",
      "summary": "Jordan Buyer added by the user"
    }
  ]
}

Response

Ingestion results.

object required

Observation, relationship, and duplicate status per input.

Changes

No recorded changes to this operation across all 50 revisions of this API.