Skip to main content

removeCustomerIntegrationMapping

Remove a customer integration mapping. The customer stops resolving to the external system's identifier.

Business Rules​

  • The mapping is archived rather than deleted, and documents already sent to the external system are unaffected.
  • Adding the same customer and integration again afterwards is allowed.

Error Scenarios​

  • **NOT_FOUND**: the mapping does not belong to this company.
  • **CONFLICT**: the mapping has already been removed.

Permissions Required​

  • customers:remove_integration_mapping permission.
removeCustomerIntegrationMapping(
  input: RemoveCustomerIntegrationMappingInput!
): RemoveCustomerIntegrationMappingPayload

Arguments​

removeCustomerIntegrationMapping.input ● RemoveCustomerIntegrationMappingInput! non-null input common​

Parameters for RemoveCustomerIntegrationMapping

Type​

RemoveCustomerIntegrationMappingPayload object common​

Autogenerated return type of RemoveCustomerIntegrationMapping.