Update Schema Configuration
PATCH {{host}}/{{version}}/{{source_name}}/schema-config
Updates the schema configuration for a source. If protocols is not enabled for the source then any updates to protocols specific configurations will not be applied.
Common JSON schema settings accept the parameters ALLOW
, OMIT_PROPERTIES
for Track Events, OMIT_TRAITS
for Identify & Group Events, and BLOCK
.
Request Body
{"schema_config"=>{"allow_unplanned_track_events"=>false, "allow_unplanned_identify_traits"=>true, "allow_unplanned_group_traits"=>false, "forwarding_blocked_events_to"=>"", "allow_unplanned_track_event_properties"=>true, "allow_track_event_on_violations"=>false, "allow_identify_traits_on_violations"=>true, "allow_group_traits_on_violations"=>false, "forwarding_violations_to"=>"", "allow_track_properties_on_violations"=>false, "common_track_event_on_violations"=>"OMIT_PROPERTIES", "common_identify_event_on_violations"=>"OMIT_TRAITS", "common_group_event_on_violations"=>"BLOCK"}, "update_mask"=>{"paths"=>["schema_config.allow_unplanned_track_events", "schema_config.allow_unplanned_identify_traits", "schema_config.allow_unplanned_group_traits", "schema_config.forwarding_blocked_events_to", "schema_config.allow_unplanned_track_event_properties", "schema_config.allow_track_event_on_violations", "schema_config.allow_identify_traits_on_violations", "schema_config.allow_group_traits_on_violations", "schema_config.forwarding_violations_to", "schema_config.allow_track_properties_on_violations", "schema_config.common_track_event_on_violations", "schema_config.common_identify_event_on_violations", "schema_config.common_group_event_on_violations"]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
"{\n \"name\": \"{{source_name}}/schema-config\",\n \"parent\": \"sources/js\",\n \"allow_unplanned_track_events\": false,\n \"allow_unplanned_identify_traits\": true,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"forwarding_blocked_events_to_source_slug\",\n \"allow_unplanned_track_event_properties\": false,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": false,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"\",\n \"allow_track_properties_on_violations\": false,\n}"