Locations
/api/helpdesk/locations/{locationId}/address
Manages HelpDesk locations. Access requires either the general configuration permission or the HelpDesk template-definition permission.
POST creates a request-local location, applies the supplied writable properties, validates it, and persists it. Identifiers are generated by the server. PUT and PATCH use the same validation. DELETE and active=false perform a soft deactivation; inactive locations remain addressable.
A configured default user location or default inventory location cannot be deactivated.
GET /api/helpdesk/locations/{locationId}/address
Optional postal or descriptive address of at most 1000 characters.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
locationId |
path | string |
yes | location identifier |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request GET /api/helpdesk/locations/<locationId>/address HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json "string"
PUT /api/helpdesk/locations/{locationId}/address
Optional postal or descriptive address of at most 1000 characters.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
locationId |
path | string |
yes | location identifier |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
string |
yes |
Optional postal or descriptive address of at most 1000 characters. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request PUT /api/helpdesk/locations/<locationId>/address HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> Content-Type: application/json "string" # Response HTTP/1.1 200 OK Content-Type: application/json "string"
Common Error Responses
The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:
{
"status": 404,
"code": "route_not_found",
"message": "The requested API route does not exist.",
"details": []
}
Schemas
Request and response schemas used on this page.
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |