Updates to client data types and external systems

Occasionally, you might need to create a new version of a client data type or modify an existing version. If the client data type version is shared with an external system, some changes that you make to the client data type version require you to redistribute its API definition document to your organization's integrator.

Overview

Important: If your changes impact existing integrations, you must follow your organization's internal process to make the latest version of the client data type API definition document available to your organization's integrator. Your integrator uses the API definition document to sync the information that is captured in respect of your latest client data type version with the external system.

Which updates impact integrations?

The table lists updates that you can make to a client data type version and whether they impact existing integrations.
Table 1. Client data type updates
  Update Does this update impact integrations? (Yes/No) More information
Attributes Adding a mandatory attribute Yes Defining attributes for a client data type
  Deleting a mandatory attribute Yes Deleting attributes from a client data type version
  Adding an optional attribute Yes Defining attributes for a client data type
Validations Adding a new validation Yes Configuring validations for a client data type
  Updating an existing validation Yes  
  Deleting a validation No  

Troubleshooting

If existing integrations fail because you did not make the API document for a new client data type version available to your organization's integrator, stop sharing your new version, then share a previous version of the client data type that you know works.