Skip to navigation
API ReferenceMatches

UpdateMatchRow

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.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

match_idstringRequiredformat: "uuid"1-36 characters
The match the row belongs to.
idstringRequiredformat: "uuid"1-36 characters
Identifier of the resource, assigned by Edulead and opaque to callers.

Headers

Edulead-TeamstringRequired

Query parameters

update_maskstringOptional
Which fields of the resource to change. Fields not listed keep their values.

Request

This endpoint expects an object.
idstringOptional<=36 characters
Identifier of the resource, assigned by Edulead and opaque to callers.
match_idstringOptional<=36 characters
The match it belongs to.
hubspot_company_idstringOptional<=50 characters
company_namestringOptional<=1024 characters
company_addressstringOptional<=1024 characters
company_statestringOptional<=50 characters

Two-letter code, or empty.

company_nces_idstringOptional<=50 characters
outcomeenumOptional

enum.defined_only = true

Allowed values:
tierenumOptional

Set when MATCHED. enum.defined_only = true

Allowed values:
subtypeenumOptional

Set for a name match. enum.defined_only = true

Allowed values:
match_confidencedouble or nullOptional
0 to 1.
institution_idstringOptional<=50 characters
The matched institution.
institution_namestringOptional<=1024 characters
institution_typestringOptional<=50 characters
institution_addressstringOptional<=1024 characters
institution_nces_idstringOptional<=50 characters
institution_nces_district_idstringOptional<=50 characters
best_candidate_namestringOptional<=1024 characters

The closest institution that was not matched, and its score (0 to 1).

best_candidate_scoredouble or nullOptional
failure_reasonenumOptional

Set when NO_MATCH. enum.defined_only = true

includedbooleanOptional
Whether an export of the match takes the row.
create_timedatetimeOptional
When Edulead created the resource.

Response

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