Create Case Enhancements

Written by First AML API team
Feb 17, 2022

On February 17th 2022 NZDT a number of minor create case mutation enhancements were introduced, these are largely focused on ensuring there is parity in behaviour between creating cases via the Public API vs. creating cases in the platform via the UI.

Changed

Mutation changes

• All create case mutations now can accept an optional name input field, which allows specifying an override for the default case name (which is normally derived from the name of the individuals or entities within the case).
• The createCaseForIndividuals mutation now allows specifying that one or more individuals are case contacts by specify the isCaseContact (mirroring the behaviour of the createCaseForEntities mutation). To ensure backwards compatibility with existing API consumers this field has been changed to be nullable as well, where a null value is interpreted as the equivalent of false. We recommend all clients plan to update to passing this value explicitly, as we will likely consider forcing it to be non-nullable in the future.

Validation changes

• When creating cases for an organisation that has one or more offices configured, the office field is now required.
• When creating cases for an organisation without any offices configured, the office field is no longer required.
• An individual that is specified as a case contact when creating a case is now validated to ensure it has at an email or phone number specified (mirroring the validation behaviour within the platform).

Planned changes

• The ability to create cases where the initialState is set to SUBMIT_TO_FIRST_AML will require at least one individual to be identified as the case contact (by having isCaseContact set to true for the individual). This will validation will be enabled for all API clients from the 1st of April 2022.

---