CAcautio
Gateway GRPC

Update an organisation

patch/v2/organisations/{id}

Request

  • Base URL
    https://api.cautio.in (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

display_namestring

Display name of the organisation

parent_idstring

Parent organisation id

vehicle_idsstring[]

Vehicle IDs to move to the organisation

excluded_user_idsstring[]

List of user IDs to exclude from auto-assignment

is_setupboolean

Whether first-time setup is complete for this organisation

Example request

{
  "display_name": "Cautio",
  "parent_id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a"
}

Response

The updated organisation

idstring required

Organisation id

display_namestring required

Display name of the organisation

parent_idstring

Effective parent organisation id when accessible to the user; omitted when the physical parent exists but is inaccessible

children_countnumber

Number of direct child organisations visible to the user

vehicle_countnumber

Total number of vehicles in this organisation and its accessible sub-organisations

is_setupboolean required

Whether first-time setup is complete for this organisation

pathOrganisationDto[] circular

Example response

{
  "id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
  "display_name": "Cautio",
  "parent_id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a"
}

Changes

No recorded changes to this operation across all 1 revision of this API.