Save person relationship

Create or update a relationship between the given person and another person. Provide the other person and both relationship labels (by their relationship property-value codes); the subject person is taken from the route. Send the relationship's id to update an existing one, or omit it to create a new one.

Required permission: Limited Write People

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the subject person.

Body Params

The relationship to save.

int32

The relationship record's unique identifier.

other
object | null

The other party in the relationship, with their profile and the label describing them.

primary
object | null

The subject person's side of the relationship, with their profile and label.

string | null

Free-text comments recorded on the relationship.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json