Update safeguard

put

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

Full update of an existing safeguard. Omitted optional fields are cleared, except on a safeguard linked to a background check, whose type and completed date stay locked. Custom field responses are sent in fields, the same shape as on create (the field's id and its response value). First retrieve the current safeguard from /api/people/{id}/safeguards/{safeguard}, apply your changes, then send back the full object.

Required permission: Write Safeguards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

safeguard

int32

required

≥ 1

The id of the safeguard.

Body Params

The updated safeguard.

type

object | null

required

The safeguard's type (one of the safeguard_types property values). On write, identify it by code.

status

object | null

required

The safeguard's status (one of the safeguard_statuses property values). On write, identify it by code or id.

fields

array of objects | null

Custom fields for this object

fields

completed

date-time | null

The date the safeguard was completed.

expires

date-time | null

The date the safeguard expires. Cannot be earlier than the completed date.

comments

string | null

Comments recorded on the safeguard. Up to 2000 characters.

files

array of objects | null

Files attached to the safeguard. Each file must first be uploaded as a safeguard document, then attached here by its id. The url downloads the file's content and requires authentication.

files

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.

404Not Found