API ReferenceComponents

Update a component

View as Markdown
Updates a component: - `name` — Rename the component. The new name must be unique within the team. Archived components can't be renamed. - `status` — Changes the component's lifecycle state: - `archive` — Marks the component as read-only. Archived components aren't deleted and can't be edited or published, but their existing versions remain accessible. - `active` — Restores the component. Only active components can be edited and published. **Note:** You can't update a name and archived state in a single call. To change both properties, make separate calls to update the name and status.

Authentication

x-api-keystring
API Key authentication via header
OR
Authorizationstring
A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

componentIdstringRequired
The component's ID.

Request

This endpoint expects any.
anyRequired
OR
anyRequired

Response

Component Updated
idstring
The component's ID.
namestring
The component's name.
statusenum

The component’s lifecycle state:

  • active — The component is active and can be edited and published.
  • archived — The component is archived and read-only. Archived components can’t be edited or published, but their existing versions remain accessible.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error