Skip to main content

UpdateIntegrationInput

Autogenerated input type of UpdateIntegration

input UpdateIntegrationInput {
  apiKey: String
  apiSecret: String
  apiToken: String
  brandId: ID
  carrierMapping: JSON
  clientMutationId: String
  description: String
  integrationId: ID!
  name: String
  settings: JSON
  status: StatusEnum
}

Fields​

UpdateIntegrationInput.apiKey ● String scalar​

The API key for the integration. This argument can be also used to store the main API key or secret for the integration. It is very important to store the main connection credential using this argument because it will be encrypted and stored in the database.

UpdateIntegrationInput.apiSecret ● String scalar​

The API secret for the integration. This argument will be encrypted and stored in the database.

UpdateIntegrationInput.apiToken ● String scalar​

The API token for the integration. This argument will be encrypted and stored in the database.

UpdateIntegrationInput.brandId ● ID scalar​

The brand id. If the header X-Brand-Id is provided then this argument is optional, otherwise it is required.

UpdateIntegrationInput.carrierMapping ● JSON scalar​

UpdateIntegrationInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

UpdateIntegrationInput.description ● String scalar​

UpdateIntegrationInput.integrationId ● ID! non-null scalar​

UpdateIntegrationInput.name ● String scalar​

UpdateIntegrationInput.settings ● JSON scalar​

Additional settings for the integration. This argument can be used to store any additional settings for the integration different from the api_key, the api_secret or the api_token.

UpdateIntegrationInput.status ● StatusEnum enum​

Member Of​

updateIntegration mutation