ArchiveExport | Edulead API

{
  "export": {
    "id": "string",
    "entity": "EXPORT_ENTITY_UNSPECIFIED",
    "target": "EXPORT_TARGET_UNSPECIFIED",
    "state": "EXPORT_STATE_UNSPECIFIED",
    "step": "EXPORT_STEP_UNSPECIFIED",
    "version": 1,
    "conditions": "string",
    "estimated_count": 1,
    "search_id": "string",
    "search_name": "string",
    "template_id": "string",
    "range_from": 1,
    "range_to": 1,
    "options": {
      "send_notification": true,
      "email_provider": "EXPORT_EMAIL_PROVIDER_UNSPECIFIED",
      "invalid_email_handling": "EXPORT_INVALID_EMAIL_HANDLING_UNSPECIFIED",
      "companyless_contacts": "EXPORT_COMPANYLESS_CONTACTS_UNSPECIFIED",
      "create_hubspot_list": true,
      "hubspot_list_name": "string",
      "account_association": "EXPORT_ACCOUNT_ASSOCIATION_UNSPECIFIED",
      "salesforce_object": "EXPORT_SALESFORCE_OBJECT_UNSPECIFIED",
      "include_child_institutions": true,
      "preserve_hierarchy": true
    },
    "match_id": "string",
    "source_export_id": "string",
    "copied_from_export_id": "string",
    "companies_export_id": "string",
    "creator_id": "string",
    "record_count": 1,
    "success_count": 1,
    "failed_count": 1,
    "skipped_count": 1,
    "file_name": "string",
    "hubspot_list_id": "string",
    "hubspot_portal_id": "string",
    "failure_message": "string",
    "review": {
      "undecided": 1,
      "take": 1,
      "skip": 1,
      "ineligible": 1,
      "total": 1,
      "missing_companies": 1
    },
    "email_verification": {
      "cached": 1,
      "sent": 1,
      "skipped_over_limit": 1
    },
    "billable_institutions": {
      "used": 1,
      "limit": 1,
      "would_unlock": 1,
      "already_unlocked": 1
    },
    "download_uri": "string",
    "create_time": "2023-01-15T01:30:15.01Z",
    "complete_time": "2023-01-15T01:30:15.01Z",
    "archive_time": "2023-01-15T01:30:15.01Z",
    "update_time": "2023-01-15T01:30:15.01Z",
    "record_ids": [
      "string"
    ]
  }
}

ArchiveExport hides the export from ListExports. A successful export cannot be archived; an archived one is returned as it is.

Authentication

AuthorizationBearer

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

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.

Response

Success

exportobjectOptional

Export is one export of people or institutions.

Authentication

Path parameters

Headers

Response