Skip to content

patchFamily

Request

Path
idinteger, (int32)required
Bodyapplication/jsonrequired
property name*anyadditional property
PATCH
/api/v1/family/{id}
curl -i -X PATCH \
  'https://api.prana.software/api/v1/family/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "property1": null,
    "property2": null
  }'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
descriptionstring

Description of the family.

Default:""
Example:"Footwear"
parentobject(ApiFamilyListReadDto)

Parent family details. Null if this is a root family.

Default:""
subfamiliesArray of objects(ApiFamilyListReadDto)

List of direct subfamilies.

Default:""
familyTypestring(ApiFamilyTypeEnum)

Type of the family: FAMILY or SUBFAMILY.

Default:""
Enum:"FAMILY""SUBFAMILY"
Example:"FAMILY"
Response
// No response example