All Collections
Apideck Unify
How to add a response field using a Field Mapping?
How to add a response field using a Field Mapping?

This guide demonstrates the process of adding extra response values using the Field Mapping feature in the Unify platform.

Updated over a week ago

Following the next steps, we will show how to add additional, custom-defined response values to a Unify response.

Let's take the example of adding an extra "gender" response key mapping to receive the raw value from the integration for the gender of an employee.


1. Configure a response key field

Choose the specific API for which you want to add a response mapping.

Click "Create Mapping" to add a new response field.

Provide a unique "Key" and a descriptive "Name." Optionally, add a brief "Description." The "key" will be utilized in the API response.

2. Map a property for an integration

Select the desired integration (e.g., Personio) to which you want to add an extra response field.

In our example case, we want to map a property from the API response from Personio (which is not a custom field).

Click through the available fields from Personio:

Press Save to store the mapping for Personio:

3. Use the mapping

The mapping is now configured, and the "gender" field will be returned in your API response as "custom_mappings.gender".

REMARK: Note that the "gender" field will be included in the response only if a value is returned by the Personio integration.

Did this answer your question?