Update Destination

PATCH {{host}}/{{version}}/{{destination_name}}

Note:

If you attempt to update read-only settings for your destination you'll encounter the following behavior:

• If only read-only properties are being updated, the endpoint will return an HTTP 400 error.

• If there's a mix of writable and read-only properties in the payload, the request will be accepted, the writable properties will be updated and the read-only properties ignored.

Request Body

{"destination"=>{"enabled"=>true, "config"=>[{"name"=>"workspaces/myworkspace/sources/js/destinations/google-analytics/config/enableServerIdentify", "type"=>"boolean", "value"=>true}]}, "update_mask"=>{"paths"=>["destination.config", "destination.enabled"]}}

HEADERS

RESPONSES

status: OK

{"name":"{{destination_name}}","parent":"{{source_name}}","display_name":"Google Analytics","enabled":true,"connection_mode":"CLOUD","config":[{"name":"{{destination_name}}/config/siteSpeedSampleRate","display_name":"Site Speed Sample Rate","value":1,"type":"number"},{"name":"{{destination_name}}/config/enhancedLinkAttribution","display_name":"Enable Enhanced Link Attribution","value":false,"type":"boolean"},{"name":"{{destination_name}}/config/sendUserId","display_name":"Send User-ID to GA","value":false,"type":"boolean"},{"name":"{{destination_name}}/config/metrics","display_name":"Custom Metrics","type":"map"},{"type":"boolean","name":"{{destination_name}}/config/nameTracker","display_name":"Name Tracker","value":false},{"display_name":"Serverside Tracking ID","value":"","type":"string","name":"{{destination_name}}/config/serversideTrackingId"},{"name":"{{destination_name}}/config/trackingId","display_name":"Website Tracking ID","value":"UA-970334309-1","type":"string"},{"name":"{{destination_name}}/config/dimensions","display_name":"Custom Dimensions","value":{"User Type":"dimension1","Gender":"dimension2"},"type":"map"},{"type":"boolean","name":"{{destination_name}}/config/classic","display_name":"Use Classic Analytics on Your Site","value":false},{"name":"{{destination_name}}/config/domain","display_name":"Cookie Domain Name","value":"","type":"string"},{"name":"{{destination_name}}/config/doubleClick","display_name":"Remarketing, Display Ads and Demographic Reports.","value":false,"type":"boolean"},{"name":"{{destination_name}}/config/ignoredReferrers","display_name":"Ignored Referrers","type":"multi-line-string"},{"name":"{{destination_name}}/config/reportUncaughtExceptions","display_name":"Send Uncaught Exceptions to GA (Mobile)","value":false,"type":"boolean"},{"value":false,"type":"boolean","name":"{{destination_name}}/config/serversideClassic","display_name":"Use Classic Analytics for Your Serverside Tracking"},{"name":"{{destination_name}}/config/anonymizeIp","display_name":"Anonymize IP Addresses","value":false,"type":"boolean"},{"name":"{{destination_name}}/config/identifyCategory","display_name":"Server Side Identify Event Category","value":"","type":"string"},{"name":"{{destination_name}}/config/nonInteraction","display_name":"Add the non-interaction flag to all events","value":false,"type":"boolean"},{"name":"{{destination_name}}/config/enhancedEcommerce","display_name":"Enable Enhanced Ecommerce","value":false,"type":"boolean"},{"name":"{{destination_name}}/config/enableServerIdentify","display_name":"Enable Server Side Identify","value":true,"type":"boolean"},{"name":"{{destination_name}}/config/identifyEventName","display_name":"Server Side Identify Event Action","value":"","type":"string"},{"value":true,"type":"boolean","name":"{{destination_name}}/config/setAllMappedProps","display_name":"Set Custom Dimensions \u0026 Metrics to the Page"},{"display_name":"Track Named Pages","value":true,"type":"boolean","name":"{{destination_name}}/config/trackNamedPages"},{"type":"map","name":"{{destination_name}}/config/contentGroupings","display_name":"Content Groupings"},{"value":"","type":"string","name":"{{destination_name}}/config/optimize","display_name":"Optimize Container ID"},{"display_name":"Track Categorized Pages","value":true,"type":"boolean","name":"{{destination_name}}/config/trackCategorizedPages"},{"display_name":"Include the Querystring in Page Views","value":false,"type":"boolean","name":"{{destination_name}}/config/includeSearch"},{"name":"{{destination_name}}/config/protocolMappings","display_name":"Map Traits or Properties to Measurement Protocol Params","type":"map"},{"name":"{{destination_name}}/config/sampleRate","display_name":"Sample Rate","value":100,"type":"number"},{"type":"boolean","name":"{{destination_name}}/config/useGoogleAmpClientId","display_name":"Use Google AMP Client ID","value":false},{"type":"string","name":"{{destination_name}}/config/mobileTrackingId","display_name":"Mobile Tracking ID","value":""}],"create_time":"2018-10-17T21:24:06.853Z","update_time":"2018-10-17T21:31:09.582Z"}