Skip to navigation
API ReferenceExports

UpdateExportReviewRecord

UpdateExportReviewRecord takes or skips one record of a reviewed export (update_mask decision). Skipping a record skips the records that hang off it; an ineligible record, and a record under a skipped one, cannot be taken.

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

export_idstringRequiredformat: "uuid"1-36 characters
The export the record 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.
export_idstringOptional<=36 characters
record_typeenumOptional

enum.defined_only = true

Allowed values:
decisionenumOptional

enum.defined_only = true

Allowed values:
operationenumOptional

The long-running operation. Poll it with WaitOperation.

Allowed values:
crm_idstringOptional<=100 characters
The record's id in the CRM.
email_statusstringOptional<=50 characters
The email verification's result, as the provider gave it.
export_statusenumOptional

enum.defined_only = true

Allowed values:
export_errorstringOptional<=500 characters
Why exporting the record failed.
decision_reasonobjectOptional
Why the review recommended the decision.
datamap from strings to stringsOptional

The record’s fields; values that are not text are compact JSON.

target_datamap from strings to stringsOptional
The values as they will be written to the CRM.
system_datamap from strings to stringsOptional
Fields the CRM sets itself.
enrichment_typestringOptional<=100 characters
How the record was enriched.
parent_idstringOptional<=36 characters
The record it hangs off.
childrenlist of objectsOptional

The records that hang off it (a contact’s institution links); one level.

create_timedatetimeOptional
When Edulead created the resource.

Response

Success
export_review_recordobjectOptional
ExportReviewRecord is one record of an export's review and its decision. Its id is the person's or institution's id, or a link's own id.