API reference › Service setup › Service types

Update an existing service type

PATCH /v1/service-types/{service_type}

Scope
settings_service_setup:edit
Roles
admin, scheduler

Update the name of an existing service type by ID.

Parameters

Path parameters

NameTypeDescription
service_type requiredinteger

ID of the service type to update.

Example 3.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
namestring

Example Updated Service.

Example

JSON
{
  "name": "Updated Service"
}

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/service-types/{service_type}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Updated Service"}'

Try it

Responses

200 Service Type updated successfully

Service Type updated successfully

JSON
{
  "success": true,
  "message": "Service Type updated!",
  "data": {
    "id": 3,
    "name": "Updated Service",
    "isCustom": true
  }
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service Type updated!.

dataobject
data.idinteger

Example 3.

data.namestring

Example Updated Service.

data.isCustomboolean

Example true.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'settings_service_setup:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_service_setup:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Service Type not found

JSON
{
  "success": false,
  "message": "Service Type with ID 3 not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Service Type with ID 3 not found..

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.