> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Update a service ticket > Update an existing service ticket. ## OpenAPI ````json PUT /api/v1/maintenance/servicetickets { "openapi": "3.0.4", "info": { "title": "Maintenance V1", "description": "# Maintenance API Documentation\nWelcome to BETA version of the new Maintenance API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.\n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## Operations \n\nThe API supports operations for the following: \n\n- **Service Tickets**\n\nFor each type, you can: \n\n- **GET**: Retrieve a list or apply filters.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Metadata" }, { "name": "ServiceTickets" } ], "paths": { "/api/v1/maintenance/servicetickets": { "put": { "tags": [ "ServiceTickets" ], "summary": "Update a service ticket", "description": "Update an existing service ticket.", "operationId": "UpdateServiceTicket", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketUpdate" } } } }, "responses": { "200": { "description": "The service ticket was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketDetails" } } } }, "400": { "description": "The service ticket data has validation issues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorMessageModel" } } } } }, "x-d360-narrative-url": "

Update a service ticket

This endpoint updates an existing service ticket.

The ticket to update is identified by its internal reference, its external identifier, or both; if both are given, they must refer to the same ticket, otherwise the request fails.

This endpoint does not accept realEstateObjectReference, reporterReference, reporterContactPersonReference, the reporterExternalContactPerson fields, or reportingDate. These are fixed at creation and cannot be changed through this endpoint. Any field that is accepted but not included in the request will be cleared, not left unchanged.

Request Fields

Field

Type

Required

Description

reference

string

Conditional

Internal identifier of the ticket to update. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values. Maximum length 100 characters.

externalIdentifier

string

Conditional

External identifier of the ticket to update, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values. Maximum length 100 characters.

externalLink

string

No

URL of the ticket in a system outside of Bloxs. Maximum length 256 characters.

stateName

string

Yes

Name of the ticket's state. States are configurable in the Bloxs admin module. Maximum length 256 characters.

priority

integer

Yes

Priority of the report. Valid values are 1 (Low), 2 (Normal), or 3 (High). Fixed list, not configurable.

problemCategoryName

string

No

Problem category the ticket belongs to. Fixed list, not configurable. Maximum length 256 characters.

costsAreForTenant

boolean

No

Indicates whether the tenant is responsible for the costs of the ticket. Default value is false, meaning the owner is responsible.

costCategoryName

string

No

Cost category of the ticket, used to determine how the associated costs should be allocated. Fixed list, not configurable. Maximum length 256 characters.

description

string

Yes

Description of the reported problem.

supplierReference

string

No

Reference of the supplier handling the ticket. Must be an existing relation in Bloxs. Maximum length 100 characters.

handledBySupplier

boolean

No

Indicates whether the supplier has accepted responsibility for resolving the ticket. Default value is false.

expectedCosts

number (double)

No

Estimated cost for resolving the issue.

isVisibleInPortal_Owner

boolean

No

Indicates whether the ticket should be visible in the Owner Portal. Only effective if the service ticket portal visibility feature is enabled for the environment.

isVisibleInPortal_Tenant

boolean

No

Indicates whether the ticket should be visible in the Tenant Portal. Only effective if the service ticket portal visibility feature is enabled for the environment.

Response Fields

Field

Type

Required

Description

reference

string

Yes

Internal identifier of the service ticket, generated by Bloxs.

externalIdentifier

string

No

External identifier of the ticket, as set by the integrating system.

externalLink

string

No

URL of the ticket in a system outside of Bloxs.

reportingDate

string (date)

Yes

Date the ticket was created.

stateName

string

Yes

Name of the ticket's current state.

priority

integer

Yes

Priority of the report. Valid values are 1 (Low), 2 (Normal), or 3 (High).

problemCategoryName

string

No

Problem category the ticket belongs to.

costsAreForTenant

boolean

No

Indicates whether the tenant is responsible for the costs of the ticket.

costCategoryName

string

No

Cost category of the ticket.

description

string

Yes

Description of the reported problem.

realEstateObjectReference

string

Yes

Reference of the real estate object the ticket applies to. Not changeable through this endpoint.

reporterReference

string

Yes

Reference of the relation to contact regarding the ticket. Not changeable through this endpoint.

reporterContactPersonReference

string

No

Reference of the contact person for communication about the ticket. Not changeable through this endpoint.

reporterExternalContactPersonName

string

No

Name of the contact person, if not registered in Bloxs. Not changeable through this endpoint.

reporterExternalContactPersonPhoneNumber

string

No

Phone number of the contact person, if not registered in Bloxs. Not changeable through this endpoint.

reporterExternalContactPersonMobileNumber

string

No

Mobile phone number of the contact person, if not registered in Bloxs. Not changeable through this endpoint.

reporterExternalContactPersonEmail

string

No

Email address of the contact person, if not registered in Bloxs. Not changeable through this endpoint.

supplierReference

string

No

Reference of the supplier handling the ticket.

handledBySupplier

boolean

No

Indicates whether the supplier has accepted responsibility for resolving the ticket.

expectedCosts

number (double)

No

Estimated cost for resolving the issue.

mandateAmount

number (double)

No

Maximum amount for which the supplier has the mandate to resolve the issue underlying the ticket.

disableUIMutations

boolean

No

Indicates whether changes to the ticket are disabled in the Bloxs application.

disableSystemTasks

boolean

No

Indicates whether the system tasks triggered by the ticket's priority are disabled.

disableSystemCorrespondence

boolean

No

Indicates whether automatic system-generated correspondence for the ticket is disabled.

isVisibleInPortal_Owner

boolean

Yes

Indicates whether the ticket is visible in the Owner Portal.

isVisibleInPortal_Tenant

boolean

Yes

Indicates whether the ticket is visible in the Tenant Portal.

" } } }, "components": { "schemas": { "ServiceTicketUpdate": { "required": [ "description", "priority", "stateName" ], "type": "object", "properties": { "reference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "externalLink": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "stateName": { "maxLength": 256, "minLength": 0, "type": "string" }, "priority": { "type": "integer", "description": "Low = 1\nNormal = 2\nHigh = 3", "format": "int32", "x-enumNames": [ "Low", "Normal", "High" ] }, "problemCategoryName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "costsAreForTenant": { "type": "boolean" }, "costCategoryName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "description": { "minLength": 1, "type": "string" }, "supplierReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "handledBySupplier": { "type": "boolean" }, "expectedCosts": { "type": "number", "format": "double", "nullable": true }, "isVisibleInPortal_Owner": { "type": "boolean", "nullable": true }, "isVisibleInPortal_Tenant": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ServiceTicketDetails": { "required": [ "description", "priority", "realEstateObjectReference", "reference", "reporterReference", "reportingDate", "stateName" ], "type": "object", "properties": { "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "externalLink": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "reportingDate": { "type": "string", "format": "date" }, "stateName": { "maxLength": 256, "minLength": 0, "type": "string" }, "priority": { "type": "integer", "description": "Low = 1\nNormal = 2\nHigh = 3", "format": "int32", "x-enumNames": [ "Low", "Normal", "High" ] }, "problemCategoryName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "costsAreForTenant": { "type": "boolean" }, "costCategoryName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "description": { "minLength": 1, "type": "string" }, "realEstateObjectReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "reporterReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "reporterContactPersonReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonPhoneNumber": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonMobileNumber": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonEmail": { "maxLength": 254, "minLength": 0, "type": "string", "nullable": true }, "supplierReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "handledBySupplier": { "type": "boolean" }, "expectedCosts": { "type": "number", "format": "double", "nullable": true }, "reference": { "maxLength": 100, "minLength": 0, "type": "string" }, "mandateAmount": { "type": "number", "format": "double", "nullable": true }, "disableUIMutations": { "type": "boolean" }, "disableSystemTasks": { "type": "boolean" }, "disableSystemCorrespondence": { "type": "boolean" }, "isVisibleInPortal_Owner": { "type": "boolean" }, "isVisibleInPortal_Tenant": { "type": "boolean" } }, "additionalProperties": false }, "APIErrorMessageModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false } } } } ````