Update person

put

https://{tenant}.onechurchsoftware.com/api/people/{id}

Full update of an existing person or business profile. Optional fields left empty are cleared. First retrieve the current person from /api/people/{id}, apply your changes, then send back the full object.

Required permission: Limited Write People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person to update.

Body Params

The full person details.

fields

array of objects | null

Custom fields for this object

fields

business

boolean | null

True when the record is a business profile rather than an individual.

title

string | null

Honorific title (e.g. Mr., Dr.) from the person's name.

first

string | null

First (given) name.

middle

string | null

Middle name.

last

string | null

Last (family) name.

suffix

string | null

Name suffix (e.g. Jr., III).

aliases

array of objects | null

The person's aliases, split from the stored comma-separated list into individual tags.

aliases

former

array of objects | null

The person's former names, split from the stored comma-separated list into individual tags.

former

description

string | null

Free-text description of the person or business.

businessAliases

array of objects | null

Business trade names, split from the stored comma-separated list into tags; populated only for business records.

businessAliases

familyPosition

object | null

The person's role within their household (e.g. Adult, Child), with code and name.

emails

array of objects | null

All of the person's email addresses, including merged family emails, each with opt-in status.

emails

phones

array of objects | null

All of the person's phone numbers, including merged family phones; mobile numbers carry text-message opt-in status.

phones

addresses

array of objects | null

All of the person's addresses, including merged family addresses, with the effective one flagged and sorted first.

addresses

family

object | null

The person's family, including members, contacts, and check-in authorized people.

barcode

string | null

The person's check-in/giving barcode identifier.

contactPreference

object | null

The person's preferred contact method, with the enum id and its description as the name.

envelopes

array of objects | null

The person's giving envelope numbers, each as a tag.

envelopes

defaultDesignation

object | null

The person's default giving designation. Populated only when the caller has the Limited Read Contributions or Full Read Accounting permission.

gender

object | null

The person's gender, with code and name.

maritalStatus

object | null

The person's marital status, with code and name.

occupation

object | null

The person's occupation, with code and name.

language

object | null

The person's preferred language, with code and name.

race

object | null

The person's race, with code and name.

ethnicity

object | null

The person's ethnicity, with code and name.

medicalNotes

string | null

Free-text medical notes for the person.

birthday

object | null

The person's birthday (month, day, year) with computed age.

anniversary

object | null

The person's anniversary (month, day, year) with computed years elapsed.

location

object | null

The person's primary location/campus, with id and name.

type

object | null

The person's record type, with code and name.

events

array of objects | null

Milestone events recorded for the person, ordered most recent first, each with an elapsed-time string.

events

links

array of objects | null

The person's web/social links, ordered by link type.

links

contact

object | null

The person's emergency contact, when one is set.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

404Not Found