Patch API Clarification

Posted by StevenL on in General discussion

When using the patch API as the documentation instructed, it throws an error and wants to ask for multiple other fields. The other fields seem irrelevant to the field I am changing (IE Requires 'If you said other, specifiy your reasoning"). There are multiple errors for this operation and I want to know whether I am doing something wrong through my patch method (Is there something that needs to be added?) Or any additional context if someone has gotten a patch request for specifically a custom field to work.

 

Note - We have a solution which is able to patch files fine, its just setting a specific flag for that user as a means to help indicate usage.

Product
Workflows API
Submitted by StevenL on October 08, 2025 Permalink

I compared workflows to the Profiles apis, is the general trend for all patch operations to rely on ALL values to be present? 

Submitted by JonB on October 09, 2025 Permalink

Hi Steven,

When you POST or PATCH a profile or workflow, iCIMS API requires you to include the data for all fields configured as required on the profile or workflow if (the "if" is critical) the fields are empty on the profile or workflow. 

For example, let's say you're trying to create a person profile and your iCIMS platform is configured to require the first name, last name, and email address be included when creating a person record. If you make a POST to create the person but only include the first name and last name, you're going to get an error message stating the email field is required. 

Back to your issue. My assumption is there are fields on the workflow or profile you're trying to update which are empty AND configured as required when you are making your patch call. 

The solution is quite simple. Your API user is in a login group. In the system configuration, un-require the fields on the profile you're trying to update that are not included in your API call, but only make them unrequired for the login group your API user is in. This will allow you to PATCH the profile with only the data you need to add to the profile without getting the error.

If that doesn't work, comment with the call you're making, the body of the call, and the actual response. Happy to help diagnose further.