Skip to navigation
API ReferenceExports

UpdateExport

UpdateExport moves the export through its steps (update_mask target, template_id, options, range_from with range_to): the target first, then the template, then the options, which start the review. A new target clears the template and the options; a reviewed export’s template, options and range can still change, without a new review.

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

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

What it carries; on create, CONTACT or INSTITUTION. enum.defined_only = true

Allowed values:
targetenumOptional

Where it goes; unset until chosen. enum.defined_only = true

Allowed values:
stateenumOptional

enum.defined_only = true

stepenumOptional

The step the running review or export is at. enum.defined_only = true

versionintegerOptional

2 for exports made through the wizard, 1 for the retired one-step exports.

conditionsstringOptional<=4096 characters

The records: a JSON array of conditions, the same as SearchPeople and SearchInstitutions take, stored as given.

estimated_countinteger or nullOptional>=0
The search's total when the export was created.
search_idstringOptional<=255 characters
The saved search the conditions came from.
search_namestringOptional<=1000 characters

That search’s name; GetExport only, empty when the search is gone.

template_idstringOptional<=36 characters

The template: which fields go where.

range_frominteger or nullOptional>=1

The first record to export, from 1; unset with range_to means all.

range_tointeger or nullOptional>=1
The last record to export, inclusive.
optionsobjectOptional

ExportOptions are the choices that start the review; each applies to some entities and targets.

match_idstringOptionalformat: "uuid"<=36 characters
The match the export came from.
source_export_idstringOptionalformat: "uuid"<=36 characters
The contact export whose missing companies this export carries.
copied_from_export_idstringOptionalformat: "uuid"<=36 characters
The export this one copied.
companies_export_idstringOptional<=36 characters
The export made from this one's missing companies.
creator_idstringOptional<=255 characters
The user or API key that created it.
record_countinteger or nullOptional

Records read; set once the run has counted them.

success_countinteger or nullOptional
failed_countinteger or nullOptional
skipped_countinteger or nullOptional
file_namestringOptional<=255 characters
The file's name, once a file export succeeded.
hubspot_list_idstringOptional<=50 characters
The HubSpot list the export made, and the portal it is in.
hubspot_portal_idstringOptional<=50 characters
failure_messagestringOptional<=10000 characters
Why the export FAILED or was REJECTED.
reviewobjectOptional

The review’s decisions; GetExport only, once the review has run.

email_verificationobjectOptional

The emails verified; GetExport only, when any were.

billable_institutionsobjectOptional

The institutions the export would unlock against the team’s limit; GetExport only, for a contact export in REVIEW when the team’s limit is not unlimited.

download_uristringOptional<=4096 characters

A link that downloads the file for five minutes; GetExport only, for a successful file export.

create_timedatetimeOptional
When Edulead created the resource.
complete_timedatetimeOptional
When the export finished.
archive_timedatetimeOptional
When the export was archived.
update_timedatetimeOptional
When any field last changed.
record_idslist of stringsOptional

On create only: the people or institutions to export, by id, instead of conditions (a selection). The export stores them as conditions.

Response

Success
exportobjectOptional
Export is one export of people or institutions.