Skip to content

Update service needed entry based on the provided request.

Request

Send the whole service needed. The name and isActive are required. The category and the locations are stored exactly as sent: a categoryId that is left out or null removes the category, and a locations list that is left out, null or empty removes every location so the service needed applies everywhere. Read the current values from POST /v2/tickets/serviceNeeded/all first when only some of them should change. For customers connected to Mapped with ticket metadata sync turned on, the sync that runs every 30 minutes writes the category from Mapped and adds or removes location rows for the twins Mapped knows, so an edit to a service needed that Mapped owns does not stick.

Security
oauth2
Path
serviceNeededIdstring, (uuid)required

The ID of the service needed.

Bodyrequired

The whole service needed to store.

namenull or string, [ 0 .. 500 ] charactersrequired

Gets or sets the name of the service needed. Required. Leading and trailing spaces are removed.

categoryIdnull or string, (uuid)

Gets or sets the category Id of the service needed. Leave it out or send null to remove the category.

isActivenull or booleanrequired

Gets or sets a value indicating whether the service needed is active. Required.

locationsArray of strings or null

Gets or sets the space twin Ids the service needed applies to. The sent list replaces the stored locations. Leave it out, send null or send an empty list to remove every location, which makes the service needed apply everywhere.

{ "name": null, "categoryId": null, "isActive": null, "locations": null }

Responses

OK

Bodyapplication/json
idstring, (uuid)

Gets or sets the unique identifier for the service needed.

namenull or string

Gets or sets the name of the service needed.

categoryIdnull or string, (uuid)

Gets or sets the category Id of the service needed.

locationsArray of strings or null

Gets or sets the locations associated with the service needed.

isActiveboolean

Gets or sets a value indicating whether service needed is active or not.

Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": null, "categoryId": null, "locations": null, "isActive": true }