{"slug":"branch-api","name":"Branch API","host":"api2.branch.io","site":"https://branch.io","category":"marketing","docsUrl":null,"sources":[{"kind":"changelog","url":"https://help.branch.io/apidocs/deep-linking.md"},{"kind":"archive","url":"https://help.branch.io/apidocs/attribution/overview.md"}],"url":"https://www.okapi.bot/providers/branch-api/","json":"https://www.okapi.bot/api/v1/providers/branch-api.json","breakingChanges":[{"slug":"the-search-ad-encoded-parameter-of-post-v1-open-is-deprecated","api":"branch-api","title":"The search_ad_encoded parameter of POST /v1/open is deprecated","kind":"behaviour_change","outcome":"fails","model":null,"announcedAt":null,"effectiveAt":null,"scope":null,"calls":["POST /v1/open","body parameter search_ad_encoded"],"method":"POST","path":"/v1/open","source":{"url":"https://help.branch.io/apidocs/attribution/overview.md","kind":"archive"},"quote":"search_ad_encoded String The Base64-encoded string of the entire response from the Apple Search Ads API. Deprecated","migration":"Send apple_attribution_token (the AdServices attribution token, within 24 hours) instead of search_ad_encoded.","migrationChange":null,"needsDecision":null,"text":{"summary":"Branch API deprecated the body parameter search_ad_encoded for POST /v1/open without a shutdown date. Calls passing this Base64-encoded string parameter will fail. Review requests sending the search_ad_encoded parameter to prevent attribution failures.","migration":"Send apple_attribution_token, providing the AdServices attribution token within 24 hours, instead of search_ad_encoded.","by":"writer"},"publishedAt":"2026-10-23T10:17:49.243Z","updatedAt":"2026-10-26T02:34:39.879Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/branch-api/breaking-changes/the-search-ad-encoded-parameter-of-post-v1-open-is-deprecated/"}]}