Enrichment

CheckEnrichEmailJob

Polls the status of an email-enrichment job created via enrich-email.

Path Parameters

  • jobId (long, required): Id returned by enrich-email when the job was created.

Response fields

  • jobId (long)

  • status (string): Where the job is in its lifecycle - one of PENDING, IN_PROGRESS, COMPLETED, FAILED.

  • data (object, optional): Present only once status is COMPLETED.

    • status (string): What the enrichment produced - one of ENRICHED, EMAIL_NOT_FOUND, CANCELLED, FAILED.

    • message (string): Human-readable summary of data.status.

    • emailAddress (string, optional): The enriched email address. Only set when data.status is ENRICHED.

    • memberId (string): LinkedIn member id of the enriched lead.

    • profileUrl (string): LinkedIn profile URL of the enriched lead.

Errors

Returns 400 with body { "errorMessage": "..." } when the job is in a state that doesn't support this operation: The enrichment job with id <jobId> is in an invalid state for this operation.

Returns 404 with body { "errorMessage": "..." } when no job with the given id exists for your tenant: Enrichment job with id <jobId> not found.

get//api/public/enrichment/enrich-email/check-job/{jobId}

Request

  • Base URL: https://api
  • URL: https://api//api/public/enrichment/enrich-email/check-job/{jobId}
  • Auth: none declared

Path parameters

jobIdstring required

(Required)

Headers

X-API-KEYstring

API key header using this scheme. Example: "X-API-KEY: {API_KEY}"

Response

OK

jobIdinteger required
statusstring required

Changes

No recorded changes to this operation across all 1 revision of this API.