Update a reference from parent company (supports companyId reassignment)

PATCH 
/parent-companies/:parent_company_id/references/:reference-id

Update a reference from parent company (supports companyId reassignment)

Request

Path Parameters

reference-id uuidrequired

application/json

Body

required

tag stringnullable

The tag of the reference.

entities

object[]

nullable

Array [

referenceType string

Possible values: [customer, oldCustomer, prospect, relation]

Default value: customer

The type of the aggregation entity.

]

access

object[]

nullable

Array [

managerId uuidrequired

primary boolean

assignment string

Possible values: [manual, automatic, team]

Default value: manual

]

companyId uuid

Reassign the reference to a different subsidiary of the same group.

Responses

200

success - a reference information

application/json

Schema

Schema

id uuidrequired

The references ID.

companyId uuidrequired

The company in which the reference is part of.

created stringnullablerequired

The date of creation of the reference.

tag stringnullable

The tag of the reference.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2024-01-01T00:00:00.000Z",
  "tag": "VIP"
}

Loading...