Add safeguard

post

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

Record a new safeguard (background check, training or similar clearance) for the given person. Identify the type and status by their safeguard_types / safeguard_statuses property-value codes. Custom field responses for the chosen type go in fields; each entry needs only the field's id and its response value. Files must already be uploaded as safeguard documents and are attached by id.

Required permission: Write Safeguards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Body Params

The safeguard to add.

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. To attach one, upload it first with type safeguard and no linkedTo, then send the returned file id here. Attaching is additive: files that are already attached stay attached when they are left out, and are removed only by deleting the file. 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

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

200OK

404Not Found