API Documentation

Create company entity relation

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

API endpoint to create a relation from a Company to either a Person or Company. The relation will be created in the direction how it is exposed in the reference data 'entity-relations'. In case of for instance Parent Company-Subsidiary relation than the relation will be created from the Subsidiary to the Parent Company.

Path Params
uuid
required

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

Body Params

Create company relation request

Model for company relation

uuid

Identifier (GUID) of the related entity.

string | null

Relation type of the related entity. This can be Person or Company.

string | null

Relation type shortcode.

date

Date when the relation is started.

date | null

Date when the relation has or will end.

extensions
array of objects | null

Relation extensions

extensions
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?