API Documentation

Create other entity relation

post
https://apim.demo01.my.fivedegrees.cloud/publicapi-sbx/api/v1/companies//other-entity-relations

API endpoint to create a relation from a company to a person.

Path Params
uuid
required

Format - uuid. Identifier (GUID) of the company.

Body Params

Create other entity relation request

Model for creating entity relation of type Other

string
required
length ≥ 1

Relation type shortcode that is being created. In the reference data endpoint 'entity-relations' a user can get the full list of available values.

uuid
required

Identifier (GUID) of the person to whom the relation should be created.

string | null

Title field where a user can specify more details on the created relation, for instance the function title of the connected Person.

date
required

Date when the created relation was started.

date | null

Date when the created relation has or will end.

Headers
uuid
required

Format - uuid. Correlates HTTP requests between a client and server

Responses
202

Accepted

500

Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?