Welcome to the New BigPanda API Documentation

Update Mapping Enrichment Schema

US Region

https://api.bigpanda.io

PATCH

/resources/v2.1/mapping-enrichment/{mapschema_id}

Updates a mapping enrichment schema.

The only fields that can be modified in the update request are the active, when, and note parameters. The mapping schema config cannot be edited. Any other fields that are changed in the Patch call will be ignored.

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.

This API uses the User API Key type of Authorization token. Your User API Key must be provided in the header, prefixed by the word Bearer.

Example:
Authorization: Bearer [YOUR_USER_API_KEY]

🚧 override_existing
If override_existing is set to false, mapping values will not be added to any alert where the field is already populated, even if the field is populated with a null.

Rate limit: 5 requests per second.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

200

Bodyapplication/json

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.bigpanda.io/resources/v2.1/mapping-enrichment/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "active": true,
    "when": {
        "IN": [
            "source_system",
            [
                {
                    "type": "regex",
                    "value": "*"
                }
            ]
        ]
    },
    "note": "Marking for regional similarity"
}'

Response Example

200 - Example 1

{
    "name": "mapping_rule",
    "fields": [
        {
            "title": "application",
            "type": "query_tag",
            "tag_name": "very_cool",
            "override_existing": false,
            "optional": true,
            "original_name": null
        }
    ],
    "id_generation_function": "uuid",
    "case_insensitive": false,
    "note": "Marking for regional similarity"
}

Modified at 2026-09-04 16:33:42

Delete Mapping Enrichment Schema

Retrieve Mapping Enrichment Table

Update Mapping Enrichment Schema

Authentication#

Request

Responses

Authentication