updateInstance

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].

Input fields (UpdateInstanceInput!)

ArgumentTypeDescription
descriptionStringAdditional notes about the Instance.
nameStringThe name of the Instance.
enabledBooleanSpecifies whether the Instance is currently enabled and in an executable state.
credentials[InputInstanceCredential]The Instance with which the Credential is associated.
configVariables[InputInstanceConfigVariable]The Instance with which the Config Variable is associated.
apiKeyStringAn optional API Key that, when specified, will be required as a header value in all requests to trigger Instance execution.
starredBooleanIndicates whether the record is starred by the signed-in User.
labels[String]The labels that are associated with the object.
idIDThe ID of the Instance to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (UpdateInstancePayload)

instance (Instance)
errors ([ErrorType])
clientMutationId (String)
Last updated on