Skip to navigation
API ReferenceMatches

CreateMatch

CreateMatch starts a match of the team’s HubSpot companies with the given strategy and properties. It returns at once, FETCHING; GetMatch follows its progress. The same request_id returns the match it started.

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>.

Headers

Edulead-TeamstringRequired

Query parameters

request_idstringOptional1-64 characters

Caller-chosen idempotency key. The same key from the same caller within 24 hours returns the original result instead of acting again.

Request

This endpoint expects an object.
idstringOptional<=36 characters
Identifier of the resource, assigned by Edulead and opaque to callers.
stateenumOptional

enum.defined_only = true

strategyenumOptional

Required on create. enum.defined_only = true

Allowed values:
hubspot_name_propertystringOptional<=255 characters

The HubSpot company property holding the company’s name; required for NAME_ADDRESS.

hubspot_address_propertystringOptional<=255 characters
The HubSpot company property holding the company's address.
hubspot_state_propertystringOptional<=255 characters

The HubSpot company property holding the company’s state; required for NAME_ADDRESS.

hubspot_nces_id_propertystringOptional<=255 characters

The HubSpot company property holding the company’s NCES id; required for NCES_ID.

creator_idstringOptional<=255 characters
The user or API key that created it.
companies_fetchedinteger or nullOptional

Companies read from HubSpot so far; unset until the first page is read.

companies_totalinteger or nullOptional

Companies the match covers; set when reading ends.

companies_matchedinteger or nullOptional

Companies matched to an institution; set when READY.

matched_by_ncesinteger or nullOptional

Companies matched by NCES id (either NCES tier); set when READY.

matched_by_nameinteger or nullOptional

Companies matched by name; set when READY.

institutions_distinctinteger or nullOptional

Distinct institutions matched; set when READY (stats.distinct_institutions is live).

failure_messagestringOptional<=10000 characters
Why the match FAILED.
hubspot_portal_idstringOptional<=50 characters

The team’s connected HubSpot account, to link a row’s company; GetMatch only, empty when the team has none.

statsobjectOptional

Counts over the rows; GetMatch only.

create_timedatetimeOptional
When Edulead created the resource.
complete_timedatetimeOptional
When the match became READY or FAILED.
update_timedatetimeOptional
When any field last changed.

Response

Success
matchobjectOptional

Match is one matching of the team’s HubSpot companies to Edulead institutions. On create, strategy and the hubspot_*_property fields are read; the service sets the others.