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

# UpdateMatchRow

PATCH https://api.getedulead.com/v4/matches/{match_id}/rows/{id}
Content-Type: application/json

UpdateMatchRow includes a row in, or excludes it from, an export of the match
 (update_mask included). Only a READY match's rows can change.

Reference: https://docs.getedulead.com/api-reference/matches/update-row

## Authentication

- `Authorization` header (bearer token, required) — A team API key, sent as `Authorization: Bearer <key>`.
- `Authorization` header (bearer token, required) — The Cognito access token of a signed-in Edulead user (`edulead auth login`), sent as `Authorization: Bearer <token>`.

## Request

### Path parameters

- `match_id` (string, required) — The match the row belongs to.
- `id` (string, required) — Identifier of the resource, assigned by Edulead and opaque to callers.

### Query parameters

- `update_mask` (string, optional) — Which fields of the resource to change. Fields not listed keep their values.

### Body (application/json)

This endpoint expects an edulead.v4.MatchRow.

- `id` (string, optional) — Identifier of the resource, assigned by Edulead and opaque to callers.
- `match_id` (string, optional) — The match it belongs to.
- `hubspot_company_id` (string, optional)
- `company_name` (string, optional)
- `company_address` (string, optional)
- `company_state` (string, optional) — Two-letter code, or empty.
- `company_nces_id` (string, optional)
- `outcome` (enum, optional) — enum.defined_only = true
  - Allowed values: `MATCH_OUTCOME_UNSPECIFIED`, `MATCH_OUTCOME_PENDING`, `MATCH_OUTCOME_MATCHED`, `MATCH_OUTCOME_NO_MATCH`
- `tier` (enum, optional) — Set when MATCHED. enum.defined_only = true
  - Allowed values: `MATCH_TIER_UNSPECIFIED`, `MATCH_TIER_NCES_ID`, `MATCH_TIER_NCES_ALT`, `MATCH_TIER_NAME_ADDRESS`
- `subtype` (enum, optional) — Set for a name match. enum.defined_only = true
  - Allowed values: `MATCH_SUBTYPE_UNSPECIFIED`, `MATCH_SUBTYPE_EXACT`, `MATCH_SUBTYPE_LEVENSHTEIN`
- `match_confidence` (double, optional, nullable) — 0 to 1.
- `institution_id` (string, optional) — The matched institution.
- `institution_name` (string, optional)
- `institution_type` (string, optional)
- `institution_address` (string, optional)
- `institution_nces_id` (string, optional)
- `institution_nces_district_id` (string, optional)
- `best_candidate_name` (string, optional) — The closest institution that was not matched, and its score (0 to 1).
- `best_candidate_score` (double, optional, nullable)
- `failure_reason` (enum, optional) — Set when NO_MATCH. enum.defined_only = true
  - Allowed values: `MATCH_FAILURE_REASON_UNSPECIFIED`, `MATCH_FAILURE_REASON_NO_CANDIDATE`, `MATCH_FAILURE_REASON_BELOW_THRESHOLD`, `MATCH_FAILURE_REASON_MULTIPLE`, `MATCH_FAILURE_REASON_NO_NAME`, `MATCH_FAILURE_REASON_NO_STATE`
- `included` (boolean, optional) — Whether an export of the match takes the row.
- `create_time` (datetime, optional) — When Edulead created the resource.

## Response

### 200

Success

- `match_row` (edulead.v4.MatchRow, optional) — MatchRow is one HubSpot company of a match and what it matched. Only included can change.

## Types

### edulead.v4.MatchRow

MatchRow is one HubSpot company of a match and what it matched. Only included can change.

- `id` (string, optional) — Identifier of the resource, assigned by Edulead and opaque to callers.
- `match_id` (string, optional) — The match it belongs to.
- `hubspot_company_id` (string, optional)
- `company_name` (string, optional)
- `company_address` (string, optional)
- `company_state` (string, optional) — Two-letter code, or empty.
- `company_nces_id` (string, optional)
- `outcome` (enum, optional) — enum.defined_only = true
  - Allowed values: `MATCH_OUTCOME_UNSPECIFIED`, `MATCH_OUTCOME_PENDING`, `MATCH_OUTCOME_MATCHED`, `MATCH_OUTCOME_NO_MATCH`
- `tier` (enum, optional) — Set when MATCHED. enum.defined_only = true
  - Allowed values: `MATCH_TIER_UNSPECIFIED`, `MATCH_TIER_NCES_ID`, `MATCH_TIER_NCES_ALT`, `MATCH_TIER_NAME_ADDRESS`
- `subtype` (enum, optional) — Set for a name match. enum.defined_only = true
  - Allowed values: `MATCH_SUBTYPE_UNSPECIFIED`, `MATCH_SUBTYPE_EXACT`, `MATCH_SUBTYPE_LEVENSHTEIN`
- `match_confidence` (double, optional, nullable) — 0 to 1.
- `institution_id` (string, optional) — The matched institution.
- `institution_name` (string, optional)
- `institution_type` (string, optional)
- `institution_address` (string, optional)
- `institution_nces_id` (string, optional)
- `institution_nces_district_id` (string, optional)
- `best_candidate_name` (string, optional) — The closest institution that was not matched, and its score (0 to 1).
- `best_candidate_score` (double, optional, nullable)
- `failure_reason` (enum, optional) — Set when NO_MATCH. enum.defined_only = true
  - Allowed values: `MATCH_FAILURE_REASON_UNSPECIFIED`, `MATCH_FAILURE_REASON_NO_CANDIDATE`, `MATCH_FAILURE_REASON_BELOW_THRESHOLD`, `MATCH_FAILURE_REASON_MULTIPLE`, `MATCH_FAILURE_REASON_NO_NAME`, `MATCH_FAILURE_REASON_NO_STATE`
- `included` (boolean, optional) — Whether an export of the match takes the row.
- `create_time` (datetime, optional) — When Edulead created the resource.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "match_row": {
    "id": "string",
    "match_id": "string",
    "hubspot_company_id": "string",
    "company_name": "string",
    "company_address": "string",
    "company_state": "string",
    "company_nces_id": "string",
    "outcome": "MATCH_OUTCOME_UNSPECIFIED",
    "tier": "MATCH_TIER_UNSPECIFIED",
    "subtype": "MATCH_SUBTYPE_UNSPECIFIED",
    "match_confidence": 1.1,
    "institution_id": "string",
    "institution_name": "string",
    "institution_type": "string",
    "institution_address": "string",
    "institution_nces_id": "string",
    "institution_nces_district_id": "string",
    "best_candidate_name": "string",
    "best_candidate_score": 1.1,
    "failure_reason": "MATCH_FAILURE_REASON_UNSPECIFIED",
    "included": true,
    "create_time": "2023-01-15T01:30:15.01Z"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.getedulead.com/v4/matches/match_id/rows/id"

payload = {}
headers = {
    "Authorization": "Bearer <apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.getedulead.com/v4/matches/match_id/rows/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

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.getedulead.com/v4/matches/match_id/rows/id"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <apiKey>")
	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.getedulead.com/v4/matches/match_id/rows/id")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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.patch("https://api.getedulead.com/v4/matches/match_id/rows/id")
  .header("Authorization", "Bearer <apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.getedulead.com/v4/matches/match_id/rows/id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.getedulead.com/v4/matches/match_id/rows/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getedulead.com/v4/matches/match_id/rows/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
```