Scopes

Scopes allows for precise control over data permissions, ensuring that only relevant Common Models and fields are synced through Merge. Disabling a Common Model Scope will also disable all of its associated fields.

Below, you’ll find endpoints related to two levels of Scopes.

  • Default Scopes apply to new Linked Accounts for a given category
  • Linked Account Scopes apply only to a specific end user (Linked Account).
The Scopes applied to a Linked Account are first determined by the Linked Account Scopes, and fall back to Default Scopes for any that haven't been set. Learn More.

This feature is only available in beta to select customers on our Professional or Enterprise plans. Contact us for more information.


GET
/default-scopes

https://api.merge.dev/api/mktg/v1/default-scopes

US
EU

Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.


GET
/linked-account-scopes

https://api.merge.dev/api/mktg/v1/linked-account-scopes

US
EU

Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.


POST
/linked-account-scopes

https://api.merge.dev/api/mktg/v1/linked-account-scopes

US
EU

Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more


Body Parameters

common_modelsArray
Required
The common models you want to update the scopes for