Skip to main content

updateInstance Mutation

Updates the specified Instance 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_instances]. 2. The signed-in User has any of the following permissions for the object: [instance_edit]. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_manage_instances]. 4. The signed-in User has any of the following permissions for the associated Customer: [customer_view_marketplace_integrations].

Input fields (UpdateInstanceInput!)#

ArgumentTypeDescription
descriptionStringAdditional notes about the Instance.
nameStringThe name of the Instance.
integrationIDThe Integration that has been deployed for the Instance.
enabledBooleanSpecifies whether the Instance is currently enabled and in an executable state.
labels[String]The labels that are associated with the object.
configVariables[InputInstanceConfigVariable]The Instance with which the Config Variable is associated.
flowConfigs[InputInstanceFlowConfig]The configuration for the IntegrationFlow associated with the Instance.
starredBooleanIndicates whether the record is starred by the signed-in User.
idIDThe ID of the Instance to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (UpdateInstancePayload)#

clientMutationId (String)#
errors ([ErrorType])#
instance (Instance)#