Skip to main content
POST
Link somebody a volunteer may bring

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
person_id
string
required

The volunteer.

linked_person_id
string
required

Somebody they may bring.

relationship
enum<string>
default:companion

guardian when linked_person_id is the volunteer's guardian.

Available options:
companion,
guardian

Response

The link, as the volunteer sees it.

id
string
required

The link.

person_id
string
required

The OTHER person: the one this volunteer may bring, or who may bring them.

display_name
string
required
relationship
enum<string>
required

How the other person stands to the one asked about: guardian is their guardian, ward is somebody they are the guardian of, companion is anybody else.

Available options:
guardian,
ward,
companion
approved_by_name
string | null
required

Who linked them.

approved_at
string<date-time>
required

When.