Custom fields are user-defined metadata that can be attached to records across iPaaS.com APIs. They appear as a custom_fields array on POST/PUT request bodies and in GET responses.
Request shape (nested inside a parent record's POST/PUT)
Each item in the custom_fields array:
Field | Type | Required | Description |
| string | No | The iPaaS.com id of the parent record this custom field belongs to. When nested inside a parent POST/PUT, this is populated automatically from the parent context. |
| string | No | Identifies which collection type this custom field applies to. When nested inside a parent POST/PUT, this is inferred from the parent context. |
| string | Yes | The name of the custom field. Must match a custom field definition configured for this collection type and company. |
| string | Yes | The value to store. Cannot be null or empty. Must conform to the data type defined on the custom field definition (string, number, bool, guid, encrypted, password, date, datetime, or enum). |
Example (nested inside a parent POST/PUT)
{
"name": "Example Product",
"custom_fields": [
{
"custom_field_name": "color",
"value": "Red"
}
]
}
Request shape (standalone Custom Field endpoint)
When calling the dedicated Custom Field POST/PUT endpoints directly (for example POST /v2/CustomField/{ApiName}), the id and type fields are required:
Field | Type | Required | Description |
| string | Yes | The iPaaS.com id of the parent record this custom field belongs to (for example the Product Id, Customer Id, etc.). |
| string | Yes | Identifies which collection type this custom field applies to. Valid values are API-specific — see the Custom Field POST endpoint for each API for the full list. |
| string | Yes | The name of the custom field. Must match a custom field definition configured for this collection type and company. |
| string | Yes | The value to store. Cannot be null or empty. |
Response shape (when reading a parent record)
Each item in the custom_fields array on a response:
Field | Type | Description |
| string | The custom field record id. |
| string | The name of the custom field. |
| string | The stored value. |
Managing custom field definitions
Custom field definitions (the schema that governs what custom fields are allowed) are managed through the Subscription API's POST /v2/CustomField and PUT /v2/CustomField/{id} endpoints. Each definition specifies the field name, data type, which collection type it applies to, and which subscription it belongs to.
Managing custom field values directly
Each data API also exposes dedicated Custom Field endpoints for creating, updating, and deleting individual custom field values outside of the parent record's POST/PUT:
POST /v2/CustomField/{ApiName}: Add a custom field value.PUT /v2/CustomField/{ApiName}/{id}: Update a custom field value by its custom field id.DELETE /v2/CustomField/{ApiName}/{id}/{type}: Remove a custom field value.