Skip to main content
POST
Create person reference

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string
required

Person UUID

Body

application/json

UUID of the other person in the reference. Must be a different person in your workspace.

reference_type
string
required

Reference type key, such as "colleague" or "manager". List the keys for your workspace with GET /v1/persons/reference-types.

Minimum string length: 1
reference_strength
enum<string> | null

How strong the relationship is: "low", "medium" or "high".

Available options:
low,
medium,
high
note
string | null

Note about the reference, such as what a reference said. Accepts plain text or HTML (bold, italics, lists, links and headings keep their formatting). Pass null to remove the note.

occurred_at
string<date-time>

ISO 8601 timestamp for when the reference actually happened (e.g. "2024-01-10T14:00:00Z"). This is distinct from created_at, which is a system-managed timestamp for when the reference was written and cannot be set by the caller. Use occurred_at to backdate a reference taken earlier. If omitted, it defaults to created_at.

Response

Reference created

success
enum<boolean>
required
Available options:
true
data
object
required