Docs

Update Component

PUT /resourceTypes/{resourceTypeId}/components/{componentId}

PUT/resourceTypes/{resourceTypeId}/components/{componentId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Edits a component. A new index reorders. Existing requests keep the components they were built from.

Requires ResourceTypeDatabase.Edit permission.

Request Body

FieldTypeRequiredDescription
labelstringRequiredThe slot's name, e.g. "Driver".
targetResourceTypeIdGuidRequiredA non-composite type (no nesting).
targetResourceVariantIdGuidOptionalA live variant of the target to pin. Null means any.
quantityintRequiredPer composite unit, at least 1.
indexintOptionalPosition. Null appends on add and keeps the position on edit.

Response

200 OK. No response body.

Error Codes

HTTP StatusDescription
400The target is composite, or the variant isn't the target's.
404Type, component, target or variant not found.
403Missing permission.