Skip to content

Update a component type

PATCH
/component-types/{id}
curl --request PATCH \
--url https://app.buildtrace.eu/api/component-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "isActive": true }'

Rename a component type and/or toggle its active state

Required scope: field:write.

id
required
string format: uuid
Media typeapplication/json
object
name
string
isActive
boolean

Example generated

{
"name": "example",
"isActive": true
}

Updated

Media typeapplication/json
object
id
required
string format: uuid
code
required
string
name
required
string
isActive
required
boolean

Example generated

{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"code": "example",
"name": "example",
"isActive": true
}

Invalid (e.g. blank name)

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Unauthorized

Not found