Skip to main content

deleteComponent Mutation

Removes the specified Component object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_components]. 2. The signed-in User has any of the following permissions for any version of the object: [component_remove]. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_component_permissions, customer_manage_components, customer_view_components].

Input fields (DeleteComponentInput!)

ArgumentTypeDescription
idIDThe ID of the Component to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (DeleteComponentPayload)

clientMutationId (String)
component (Component)
errors ([ErrorType!]!)