API Reference
Knowledge Base

Update a service

patch
https://api.katanamrp.com/v1/services/

Updates the specified service by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Service id

Body Params

Service details

string
string
length ≤ 7
string
string
boolean
boolean
number | null
0 to 100000000000
number | null
0 to 100000000000
string
custom_fields

Custom field values on the service. A service has exactly one variant, so its custom fields are set here rather than on a variants array.

In the object representation the values are merged, not replaced: omit a key to leave it unchanged, and send null to clear one.

integer | null
≤ 2147483647

Custom fields collection the item draws its legacy {field_name, field_value} custom fields from. Belongs to the legacy representation only — sending it together with object-form custom_fields is rejected with a 422. See the X-Custom-Fields-Format header.

Headers
string
enum

Selects the representation of custom_fields on items, for both the request body and the response.

  • default — object keyed by custom field definition id (UUID).
  • legacy — the {field_name, field_value} array tied to custom fields collections.

Most accounts do not need this header: an account that has not moved to item custom fields always gets legacy, and an account that has moved and no longer uses collections always gets the object representation. The header matters only while both are available for the account, where legacy is the default and default opts into the object representation.

Requesting a representation the account does not have returns 422, as does sending a custom_fields body whose shape does not match the representation in force, mixing both shapes in one request, or combining custom_field_collection_id with the object representation — that field belongs to the legacy representation and is left out of responses entirely under the object one. Responses vary on this header.

Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 5 months ago

Did this page help you?