Update connection

put

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

Update an existing connection. This is a full update: optional fields that are omitted are cleared. First retrieve the current connection from /api/connections/{id}, apply your changes, then send back the full object. Changing the assignee requires the Full Write Connections permission.

Required permission: Full Write Connections

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the connection to update.

Body Params

The details of the connection

type

object | null

required

The connection's type. On a connection only the type's id, code, name and fields are populated, and the fields are filtered to this connection's responses. Set the type by code when creating; the type cannot be changed on update.

person

object | null

required

The person the connection is about. Set the person by id when creating; it cannot be changed afterward.

status

object | null

required

The connection's status. Set by code.

date

date-time | null

required

The connection's effective date.

fields

array of objects | null

Custom fields for this object

fields

campus

object | null

The campus (location) the connection belongs to. Set by id, or omit to clear.

assignee

object | null

The person the connection is assigned to. Set by id, or omit to leave it unassigned; changing the assignee emails the new and former assignees.

due

date-time | null

The connection's due date. Required when an assignee is set.

completed

date-time | null

The date the connection was completed. Required when the status is completed.

outcome

string | null

The connection's outcome notes.

comments

string | null

The connection's initial notes.

comment

string | null

Adds a new comment to the connection when saving. To add a comment on its own, use /api/connections/{id}/comments.

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