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].
Input fields (UpdateInstanceInput!)#
| Argument | Type | Description |
|---|---|---|
description | String | Additional notes about the Instance. |
name | String | The name of the Instance. |
integration | ID | The Integration that has been deployed for the Instance. |
enabled | Boolean | Specifies whether the Instance is currently enabled and in an executable state. |
apiKey | String | An optional API Key that, when specified, will be required as a header value in all requests to trigger Instance execution. |
testPayload | String | Data payload for testing this Instance. |
testContentType | String | Content type of the payload for testing this Instance. |
configVariables | [InputInstanceConfigVariable] | The Instance with which the Config Variable is associated. |
starred | Boolean | Indicates whether the record is starred by the signed-in User. |
labels | [String] | The labels that are associated with the object. |
id | ID | The ID of the Instance to mutate. |
clientMutationId | String | A unique identifier for the client performing the mutation. |