> This page is for Unified.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# /linked-account-scopes

POST https://api.merge.dev/api/crm/v1/linked-account-scopes
Content-Type: application/json

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](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)

Reference: https://docs.merge.dev/merge-unified/crm/data-management/scopes/linked-account-scopes-retrieve

## Authentication

- `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer"

## Servers

- `https://api.merge.dev/api` (Production, default)
- `https://api-eu.merge.dev/api` (ProductionEU)
- `https://api-ap.merge.dev/api` (ProductionAPSE1)

## Request

### Headers

- `X-Account-Token` (string, required) — Token identifying the end user.

### Body (application/json)

This endpoint expects a LinkedAccountCommonModelScopeDeserializerRequest.

- `common_models` (list of IndividualCommonModelScopeDeserializerRequest, required) — The common models you want to update the scopes for

## Response

### 200

- `common_models` (list of IndividualCommonModelScopeDeserializer, required) — The common models you want to update the scopes for

## Types

### IndividualCommonModelScopeDeserializerRequest

- `model_name` (string, required)
- `model_permissions` (map from string to ModelPermissionDeserializerRequest, optional)
- `field_permissions` (FieldPermissionDeserializerRequest, optional)

### IndividualCommonModelScopeDeserializer

- `model_name` (string, required)
- `model_permissions` (map from string to ModelPermissionDeserializer, optional)
- `field_permissions` (FieldPermissionDeserializer, optional)

### ModelPermissionDeserializerRequest

- `is_enabled` (boolean, optional)

### FieldPermissionDeserializerRequest

- `enabled_fields` (list of any, optional)
- `disabled_fields` (list of any, optional)

### ModelPermissionDeserializer

- `is_enabled` (boolean, optional)

### FieldPermissionDeserializer

- `enabled_fields` (list of any, optional)
- `disabled_fields` (list of any, optional)

## Examples

**Request**

```json
{
  "common_models": [
    {
      "model_name": "Employee",
      "model_permissions": {
        "READ": {
          "is_enabled": true
        },
        "WRITE": {
          "is_enabled": false
        }
      },
      "field_permissions": {
        "enabled_fields": [
          "avatar",
          "home_location"
        ],
        "disabled_fields": [
          "work_location"
        ]
      }
    },
    {
      "model_name": "Benefit",
      "model_permissions": {
        "WRITE": {
          "is_enabled": false
        }
      }
    }
  ]
}
```

**Response**

```json
{
  "common_models": [
    {
      "model_name": "Employee",
      "model_permissions": {
        "READ": {
          "is_enabled": true
        },
        "WRITE": {
          "is_enabled": false
        }
      },
      "field_permissions": {
        "enabled_fields": [
          "avatar",
          "created_at",
          "custom_fields",
          "date_of_birth",
          "first_name",
          "gender",
          "remote_created_at",
          "remote_data"
        ],
        "disabled_fields": [
          "company",
          "employments",
          "groups",
          "home_location",
          "manager",
          "work_location"
        ]
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.merge.dev/api/crm/v1/linked-account-scopes"

payload = { "common_models": [
        {
            "model_name": "Employee",
            "model_permissions": {
                "READ": { "is_enabled": True },
                "WRITE": { "is_enabled": False }
            },
            "field_permissions": {
                "enabled_fields": ["avatar", "home_location"],
                "disabled_fields": ["work_location"]
            }
        },
        {
            "model_name": "Benefit",
            "model_permissions": { "WRITE": { "is_enabled": False } }
        }
    ] }
headers = {
    "X-Account-Token": "X-Account-Token",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.merge.dev/api/crm/v1/linked-account-scopes';
const options = {
  method: 'POST',
  headers: {
    'X-Account-Token': 'X-Account-Token',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"common_models":[{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled_fields":["avatar","home_location"],"disabled_fields":["work_location"]}},{"model_name":"Benefit","model_permissions":{"WRITE":{"is_enabled":false}}}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.merge.dev/api/crm/v1/linked-account-scopes"

	payload := strings.NewReader("{\n  \"common_models\": [\n    {\n      \"model_name\": \"Employee\",\n      \"model_permissions\": {\n        \"READ\": {\n          \"is_enabled\": true\n        },\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      },\n      \"field_permissions\": {\n        \"enabled_fields\": [\n          \"avatar\",\n          \"home_location\"\n        ],\n        \"disabled_fields\": [\n          \"work_location\"\n        ]\n      }\n    },\n    {\n      \"model_name\": \"Benefit\",\n      \"model_permissions\": {\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Token", "X-Account-Token")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.merge.dev/api/crm/v1/linked-account-scopes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Account-Token"] = 'X-Account-Token'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"common_models\": [\n    {\n      \"model_name\": \"Employee\",\n      \"model_permissions\": {\n        \"READ\": {\n          \"is_enabled\": true\n        },\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      },\n      \"field_permissions\": {\n        \"enabled_fields\": [\n          \"avatar\",\n          \"home_location\"\n        ],\n        \"disabled_fields\": [\n          \"work_location\"\n        ]\n      }\n    },\n    {\n      \"model_name\": \"Benefit\",\n      \"model_permissions\": {\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.merge.dev/api/crm/v1/linked-account-scopes")
  .header("X-Account-Token", "X-Account-Token")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"common_models\": [\n    {\n      \"model_name\": \"Employee\",\n      \"model_permissions\": {\n        \"READ\": {\n          \"is_enabled\": true\n        },\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      },\n      \"field_permissions\": {\n        \"enabled_fields\": [\n          \"avatar\",\n          \"home_location\"\n        ],\n        \"disabled_fields\": [\n          \"work_location\"\n        ]\n      }\n    },\n    {\n      \"model_name\": \"Benefit\",\n      \"model_permissions\": {\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      }\n    }\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.merge.dev/api/crm/v1/linked-account-scopes', [
  'body' => '{
  "common_models": [
    {
      "model_name": "Employee",
      "model_permissions": {
        "READ": {
          "is_enabled": true
        },
        "WRITE": {
          "is_enabled": false
        }
      },
      "field_permissions": {
        "enabled_fields": [
          "avatar",
          "home_location"
        ],
        "disabled_fields": [
          "work_location"
        ]
      }
    },
    {
      "model_name": "Benefit",
      "model_permissions": {
        "WRITE": {
          "is_enabled": false
        }
      }
    }
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Account-Token' => 'X-Account-Token',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.merge.dev/api/crm/v1/linked-account-scopes");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Account-Token", "X-Account-Token");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"common_models\": [\n    {\n      \"model_name\": \"Employee\",\n      \"model_permissions\": {\n        \"READ\": {\n          \"is_enabled\": true\n        },\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      },\n      \"field_permissions\": {\n        \"enabled_fields\": [\n          \"avatar\",\n          \"home_location\"\n        ],\n        \"disabled_fields\": [\n          \"work_location\"\n        ]\n      }\n    },\n    {\n      \"model_name\": \"Benefit\",\n      \"model_permissions\": {\n        \"WRITE\": {\n          \"is_enabled\": false\n        }\n      }\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Account-Token": "X-Account-Token",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["common_models": [
    [
      "model_name": "Employee",
      "model_permissions": [
        "READ": ["is_enabled": true],
        "WRITE": ["is_enabled": false]
      ],
      "field_permissions": [
        "enabled_fields": ["avatar", "home_location"],
        "disabled_fields": ["work_location"]
      ]
    ],
    [
      "model_name": "Benefit",
      "model_permissions": ["WRITE": ["is_enabled": false]]
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/crm/v1/linked-account-scopes")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```